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

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

public interface XMLParseStatement
extends Stmt

A representation of an XML PARSE statement.

The following features are supported:

See Also:
COBOLPackage.getXMLParseStatement()

Field Summary
static java.lang.String copyright
           
 
Method Summary
 DataRefOrLiteral getEncoding()
          Returns the value of the 'Encoding' containment reference.
 SectionOrParagraph getFirstProcessingProcedure()
          Returns the value of the 'First Processing Procedure' reference.
 SectionOrParagraph getLastProcessingProcedure()
          Returns the value of the 'Last Processing Procedure' 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.
 ValidatingClause getValidatingClause()
          Returns the value of the 'Validating Clause' containment reference.
 DataRef getXmlData()
          Returns the value of the 'Xml Data' containment reference.
 boolean isEndXMLUsed()
          Returns the value of the 'End XML Used' attribute.
 boolean isReturningNational()
          Returns the value of the 'Returning National' attribute.
 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 setFirstProcessingProcedure(SectionOrParagraph value)
          Sets the value of the 'First Processing Procedure' reference.
 void setLastProcessingProcedure(SectionOrParagraph value)
          Sets the value of the 'Last Processing Procedure' reference.
 void setReturningNational(boolean value)
          Sets the value of the 'Returning National' attribute.
 void setValidatingClause(ValidatingClause value)
          Sets the value of the 'Validating Clause' containment reference.
 void setXmlData(DataRef value)
          Sets the value of the 'Xml Data' containment reference.
 
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

getXmlData

DataRef getXmlData()
Returns the value of the 'Xml Data' containment reference.

The value is a reference to the data item that holds the XML data to be parsed.

Returns:
the value of the 'Xml Data' containment reference.
See Also:
setXmlData(DataRef), COBOLPackage.getXMLParseStatement_XmlData()

setXmlData

void setXmlData(DataRef value)
Sets the value of the 'Xml Data' containment reference.

Parameters:
value - the new value of the 'Xml Data' containment reference.
See Also:
getXmlData()

getEncoding

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

The value is the code page specified in the ENCODING clause.

Returns:
the value of the 'Encoding' containment reference.
See Also:
setEncoding(DataRefOrLiteral), COBOLPackage.getXMLParseStatement_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()

isReturningNational

boolean isReturningNational()
Returns the value of the 'Returning National' attribute.

The value is true if the RETURNING NATIONAL clause is present; false otherwise.

Returns:
the value of the 'Returning National' attribute.
See Also:
setReturningNational(boolean), COBOLPackage.getXMLParseStatement_ReturningNational()

setReturningNational

void setReturningNational(boolean value)
Sets the value of the 'Returning National' attribute.

Parameters:
value - the new value of the 'Returning National' attribute.
See Also:
isReturningNational()

getValidatingClause

ValidatingClause getValidatingClause()
Returns the value of the 'Validating Clause' containment reference.

The value is a representation of the VALIDATING clause if it is present; if the clause is not present, the value is null.

Returns:
the value of the 'Validating Clause' containment reference.
See Also:
setValidatingClause(ValidatingClause), COBOLPackage.getXMLParseStatement_ValidatingClause()

setValidatingClause

void setValidatingClause(ValidatingClause value)
Sets the value of the 'Validating Clause' containment reference.

Parameters:
value - the new value of the 'Validating Clause' containment reference.
See Also:
getValidatingClause()

getFirstProcessingProcedure

SectionOrParagraph getFirstProcessingProcedure()
Returns the value of the 'First Processing Procedure' reference.

The value is the first procedure in the PROCESSING PROCEDURE clause.

Returns:
the value of the 'First Processing Procedure' reference.
See Also:
setFirstProcessingProcedure(SectionOrParagraph), COBOLPackage.getXMLParseStatement_FirstProcessingProcedure()

setFirstProcessingProcedure

void setFirstProcessingProcedure(SectionOrParagraph value)
Sets the value of the 'First Processing Procedure' reference.

Parameters:
value - the new value of the 'First Processing Procedure' reference.
See Also:
getFirstProcessingProcedure()

getLastProcessingProcedure

SectionOrParagraph getLastProcessingProcedure()
Returns the value of the 'Last Processing Procedure' reference.

The value is the processing procedure specified after the THRU keyword in the PROCESSING PROCEDURE clause. If there is no such processing procedure, the value is null.

Returns:
the value of the 'Last Processing Procedure' reference.
See Also:
setLastProcessingProcedure(SectionOrParagraph), COBOLPackage.getXMLParseStatement_LastProcessingProcedure()

setLastProcessingProcedure

void setLastProcessingProcedure(SectionOrParagraph value)
Sets the value of the 'Last Processing Procedure' reference.

Parameters:
value - the new value of the 'Last Processing Procedure' reference.
See Also:
getLastProcessingProcedure()

getOnException

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

The list contains the statements in the ON EXCEPTION clause.

Returns:
the value of the 'On Exception' containment reference list.
See Also:
COBOLPackage.getXMLParseStatement_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 list contains the statements in the NOT ON EXCEPTION clause.

Returns:
the value of the 'Not On Exception' containment reference list.
See Also:
COBOLPackage.getXMLParseStatement_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.getXMLParseStatement_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()