com.ibm.etools.cobol.application.model.cobol
Interface XMLGenerateStmt

All Superinterfaces:
ASTNode, org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier, Stmt

public interface XMLGenerateStmt
extends Stmt

A representation of an XML GENERATE statement.

The following features are supported:

See Also:
COBOLPackage.getXMLGenerateStmt()

Field Summary
static java.lang.String copyright
           
 
Method Summary
 DataRef getCountDataItem()
          Returns the value of the 'Count Data Item' containment reference.
 DataRefOrLiteral getEncoding()
          Returns the value of the 'Encoding' containment reference.
 DataRef getFromDataItem()
          Returns the value of the 'From Data Item' containment reference.
 DataRefOrLiteral getNamespace()
          Returns the value of the 'Namespace' containment reference.
 DataRefOrLiteral getNamespacePrefix()
          Returns the value of the 'Namespace Prefix' containment reference.
 java.util.List getNotOnException()
          Returns the value of the 'Not On Exception' containment reference list.
 java.util.List getOnException()
          Returns the value of the 'On Exception' containment reference list.
 DataRef getReceivingArea()
          Returns the value of the 'Receiving Area' containment reference.
 boolean isAttributesUsed()
          Returns the value of the 'Attributes Used' attribute.
 boolean isEndXMLUsed()
          Returns the value of the 'End XML Used' attribute.
 boolean isXmlDeclarationUsed()
          Returns the value of the 'Xml Declaration Used' attribute.
 void setAttributesUsed(boolean value)
          Sets the value of the 'Attributes Used' attribute.
 void setCountDataItem(DataRef value)
          Sets the value of the 'Count Data Item' containment reference.
 void setEncoding(DataRefOrLiteral value)
          Sets the value of the 'Encoding' containment reference.
 void setEndXMLUsed(boolean value)
          Sets the value of the 'End XML Used' attribute.
 void setFromDataItem(DataRef value)
          Sets the value of the 'From Data Item' containment reference.
 void setNamespace(DataRefOrLiteral value)
          Sets the value of the 'Namespace' containment reference.
 void setNamespacePrefix(DataRefOrLiteral value)
          Sets the value of the 'Namespace Prefix' containment reference.
 void setReceivingArea(DataRef value)
          Sets the value of the 'Receiving Area' containment reference.
 void setXmlDeclarationUsed(boolean value)
          Sets the value of the 'Xml Declaration Used' attribute.
 
Methods inherited from interface com.ibm.etools.cobol.application.model.cobol.ASTNode
getBeginColumn, getBeginFile, getBeginLine, getEndColumn, getEndFile, getEndLine, getParent, getTag, setBeginColumn, setBeginFile, setBeginLine, setEndColumn, setEndFile, setEndLine, setParent, setTag
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Field Detail

copyright

static final java.lang.String copyright

See Also:
Constant Field Values
Method Detail

getReceivingArea

DataRef getReceivingArea()
Returns the value of the 'Receiving Area' containment reference.

The value is a reference to the data item that will receive the generated XML.

Returns:
the value of the 'Receiving Area' containment reference.
See Also:
setReceivingArea(DataRef), COBOLPackage.getXMLGenerateStmt_ReceivingArea()

setReceivingArea

void setReceivingArea(DataRef value)
Sets the value of the 'Receiving Area' containment reference.

Parameters:
value - the new value of the 'Receiving Area' containment reference.
See Also:
getReceivingArea()

getFromDataItem

DataRef getFromDataItem()
Returns the value of the 'From Data Item' containment reference.

The value is the data item that contains the data to be converted to XML.

Returns:
the value of the 'From Data Item' containment reference.
See Also:
setFromDataItem(DataRef), COBOLPackage.getXMLGenerateStmt_FromDataItem()

setFromDataItem

void setFromDataItem(DataRef value)
Sets the value of the 'From Data Item' containment reference.

Parameters:
value - the new value of the 'From Data Item' containment reference.
See Also:
getFromDataItem()

getCountDataItem

DataRef getCountDataItem()
Returns the value of the 'Count Data Item' containment reference.

The value is the data item in the COUNT phrase; if the COUNT phrase is not present, the value is null.

Returns:
the value of the 'Count Data Item' containment reference.
See Also:
setCountDataItem(DataRef), COBOLPackage.getXMLGenerateStmt_CountDataItem()

setCountDataItem

void setCountDataItem(DataRef value)
Sets the value of the 'Count Data Item' containment reference.

Parameters:
value - the new value of the 'Count Data Item' containment reference.
See Also:
getCountDataItem()

getEncoding

DataRefOrLiteral getEncoding()
Returns the value of the 'Encoding' containment reference.

The value is the encoding specified in the ENCODING phrase; if that phrase is not present, the value is null.

Returns:
the value of the 'Encoding' containment reference.
See Also:
setEncoding(DataRefOrLiteral), COBOLPackage.getXMLGenerateStmt_Encoding()

setEncoding

void setEncoding(DataRefOrLiteral value)
Sets the value of the 'Encoding' containment reference.

Parameters:
value - the new value of the 'Encoding' containment reference.
See Also:
getEncoding()

isXmlDeclarationUsed

boolean isXmlDeclarationUsed()
Returns the value of the 'Xml Declaration Used' attribute.

The value is true if the XML-DECLARATION phrase is present; false otherwise.

Returns:
the value of the 'Xml Declaration Used' attribute.
See Also:
setXmlDeclarationUsed(boolean), COBOLPackage.getXMLGenerateStmt_XmlDeclarationUsed()

setXmlDeclarationUsed

void setXmlDeclarationUsed(boolean value)
Sets the value of the 'Xml Declaration Used' attribute.

Parameters:
value - the new value of the 'Xml Declaration Used' attribute.
See Also:
isXmlDeclarationUsed()

isAttributesUsed

boolean isAttributesUsed()
Returns the value of the 'Attributes Used' attribute.

The value is true if the ATTRIBUTES phrase is present; false otherwise.

Returns:
the value of the 'Attributes Used' attribute.
See Also:
setAttributesUsed(boolean), COBOLPackage.getXMLGenerateStmt_AttributesUsed()

setAttributesUsed

void setAttributesUsed(boolean value)
Sets the value of the 'Attributes Used' attribute.

Parameters:
value - the new value of the 'Attributes Used' attribute.
See Also:
isAttributesUsed()

getNamespace

DataRefOrLiteral getNamespace()
Returns the value of the 'Namespace' containment reference.

The value is the namespace; if no namespace is specified, the value is null.

Returns:
the value of the 'Namespace' containment reference.
See Also:
setNamespace(DataRefOrLiteral), COBOLPackage.getXMLGenerateStmt_Namespace()

setNamespace

void setNamespace(DataRefOrLiteral value)
Sets the value of the 'Namespace' containment reference.

Parameters:
value - the new value of the 'Namespace' containment reference.
See Also:
getNamespace()

getNamespacePrefix

DataRefOrLiteral getNamespacePrefix()
Returns the value of the 'Namespace Prefix' containment reference.

The value is the namespace prefix; if no namespace prefix is specified, the value is null.

Returns:
the value of the 'Namespace Prefix' containment reference.
See Also:
setNamespacePrefix(DataRefOrLiteral), COBOLPackage.getXMLGenerateStmt_NamespacePrefix()

setNamespacePrefix

void setNamespacePrefix(DataRefOrLiteral value)
Sets the value of the 'Namespace Prefix' containment reference.

Parameters:
value - the new value of the 'Namespace Prefix' containment reference.
See Also:
getNamespacePrefix()

getOnException

java.util.List getOnException()
Returns the value of the 'On Exception' containment reference list. The list contents are of type Stmt.

The items in the list are the statements in the ON EXCEPTION phrase.

Returns:
the value of the 'On Exception' containment reference list.
See Also:
COBOLPackage.getXMLGenerateStmt_OnException()

getNotOnException

java.util.List getNotOnException()
Returns the value of the 'Not On Exception' containment reference list. The list contents are of type Stmt.

The items in the list are the statements in the NOT ON EXCEPTION phrase.

Returns:
the value of the 'Not On Exception' containment reference list.
See Also:
COBOLPackage.getXMLGenerateStmt_NotOnException()

isEndXMLUsed

boolean isEndXMLUsed()
Returns the value of the 'End XML Used' attribute.

The value is true if the END-XML keyword is present; false otherwise.

Returns:
the value of the 'End XML Used' attribute.
See Also:
setEndXMLUsed(boolean), COBOLPackage.getXMLGenerateStmt_EndXMLUsed()

setEndXMLUsed

void setEndXMLUsed(boolean value)
Sets the value of the 'End XML Used' attribute.

Parameters:
value - the new value of the 'End XML Used' attribute.
See Also:
isEndXMLUsed()