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

All Superinterfaces:
org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier
All Known Subinterfaces:
AbstractDataItem, AcceptDataTransferStmt, AcceptStmt, AcceptSystemInfoTransferStmt, ActualParameter, AddCorrStmt, AddressingItem, AddressOf, AddStmt, AddToGivingStmt, AddToStmt, AllSubscript, Alphabet, AlphabeticItem, AlphaNumericEditedItem, AlphaNumericItem, AlterClause, AlternateKeyClause, AlterStmt, ApplyWriteOnlyClause, ArithOperand, ArithStmt, AssignmentName, AssignmentNameOrLiteral, BaseProgram, BinarySearchStmt, BlockContainsClause, Branch, ByClause, CallStmt, CancelStmt, CBLProcessStmt, CicsStmt, ClassClause, ClassName, CloseObject, CloseReel, CloseReelOrUnit, CloseStmt, CloseUnit, CompilerDirectingStmt, CompilerOption, CompilerSubOption, ComputeStmt, ConfigurationSection, ContinueStmt, CopyReplacingClause, CopyStmt, CurrencySignClause, DataDivision, DataItem, DataRecordClause, DataRef, DataRefOrIndexRef, DataRefOrLiteral, DataRefOrLiteralOrIndexRef, DataSubscript, DateFormatClause, DBCSItem, DebuggingUseStmt, Declaratives, DeclarativesContent, DeleteStmt, DisplayStmt, DivideByGivingRemainderStmt, DivideByGivingSimpleStmt, DivideByGivingStmt, DivideIntoGivingRemainderStmt, DivideIntoGivingSimpleStmt, DivideIntoGivingStmt, DivideIntoSimpleStmt, DivideStmt, EjectStmt, ElementaryDataItem, EndOfReelClause, EndOfUnitClause, EntryStmt, Environment, EnvironmentDivision, EvaluateAny, EvaluateExpr, EvaluateExprRange, EvaluateObject, EvaluateStmt, EvaluateWhenBlock, EvaluateWhenClause, EveryRecordsClause, ExceptionUseStmt, ExecCicsStmt, ExecSqlStmt, ExitProgramStmt, ExitStmt, Expr, Expr88Cond, ExprArithAdd, ExprArithBinary, ExprArithDivide, ExprArithExpo, ExprArithmetic, ExprArithMultiply, ExprArithSubtract, ExprArithUnaryMinus, ExprArithUnaryPlus, ExprClassCond, ExprComplexCond, ExprConditional, ExprDataRef, ExprEqual, ExprGreater, ExprGreaterOrEqual, ExprIndexRef, ExprIsNotSignCond, ExprIsNotStdClassCond, ExprIsNotUserClassCond, ExprIsSignCond, ExprIsStdClassCond, ExprIsUserClassCond, ExprLess, ExprLessOrEqual, ExprLiteral, ExprLogicalAnd, ExprLogicalBinary, ExprLogicalNot, ExprLogicalOr, ExprNotEqual, ExprNotGreater, ExprNotLess, ExprRelationCond, ExprSignCond, ExprSimpleCond, ExprStdClassCond, ExprSwitchStatusCond, ExprUserClassCond, FileAccessModeClause, FileControlEntry, FileDescriptionEntry, FilePositionClause, FileSection, FixedTableDataItem, FormalParameter, FuncPtrItem, FuncRef, GoBackStmt, GoToConditionalStmt, GoToMoreLabelsStmt, GoToStmt, GoToUnconditionalStmt, GroupDataItem, GroupUsageClause, IdentificationDivision, IfThenElseStmt, ImplicitDataRef, IndexedFileControlEntry, IndexRef, IndexSubscript, IndexVariable, InitializeStmt, InputOutputSection, InspectAfterClause, InspectBeforeClause, InspectBeforeOrAfterClause, InspectConvertingStmt, InspectReplacingAll, InspectReplacingAllOrLeadingOrFirst, InspectReplacingAllOrLeadingOrFirstClause, InspectReplacingCharactersBy, InspectReplacingClause, InspectReplacingFirst, InspectReplacingLeading, InspectReplacingStmt, InspectStmt, InspectTallyingAll, InspectTallyingAllOrLeading, InspectTallyingAllOrLeadingClause, InspectTallyingCharacters, InspectTallyingClause, InspectTallyingComparand, InspectTallyingLeading, InspectTallyingReplacingStmt, InspectTallyingStmt, IntSubscript, IOControlParagraphClause, IOFiles, IOFilesOrProcedure, IOProcedure, JavaCOBOLDataType, KeyCondition, LabelRecordsClause, LabelUseStmt, LengthOf, Level01Item, Level66Item, Level77Item, Level88Item, Level88ItemRef, LibraryClause, LinageClause, LinageCounter, LineSequentialFileControlEntry, LinkageSection, Literal, LiteralOrLiteralValueRange, LiteralTypedValue, LiteralValueList, LiteralValueRange, LocalStorageSection, MemorySize, MergeStmt, MnemonicName, MoveCorrStmt, MoveSimpleStmt, MoveStmt, MultipleFileTapeClause, MultiplyByGivingStmt, MultiplyByStmt, MultiplyStmt, NamedElement, NumericEditedItem, NumericItem, ObjectComputerParagraph, ObjectReferenceItem, OnKeyClause, OpenClause, OpenObject, OpenStmt, Paragraph, PerformBody, PerformFromTo, PerformInline, PerformIterationController, PerformStmt, PIControllerTimes, PIControllerUntil, PIControllerVarying, PIControllerVaryingClause, PointerItem, PositionClause, ProcedureDivision, ProcedureDivisionContent, ProcedureDivisionHeader, ProcPtrItem, Program, ProgramSourceFile, QualifiedRef, Qualifier, ReadStmt, RecordClause, RecordingModeClause, RefMod, RelativeFileControlEntry, ReleaseStmt, ReplaceOffStmt, ReplaceStmt, ReplacingClause, RepositoryParagraph, RerunClause, ReservePhrase, ReturnStmt, RewriteStmt, SameAreaClause, SameRecordAreaClause, SameSortAreaClause, SameSortMergeAreaClause, SearchStmt, SearchWhenClause, Section, SectionOrParagraph, Sentence, SequentialFileControlEntry, SerialSearchStmt, ServiceLabelStmt, Set88ItemsStmt, SetAdjustIndicesStmt, SetIndicesStmt, SetObjectRefToNullStmt, SetObjectRefToObjectRefStmt, SetPointersStmt, SetPointersToAddressStmt, SetPointersToEntryStmt, SetPointersToNullStmt, SetPointersToPointerStmt, SetProcPointersStmt, SetProcPointersToEntryStmt, SetProcPointersToNullStmt, SetProcPointersToPointerStmt, SetProcPointersToProcPointerStmt, SetStmt, SetSwitchesClause, SetSwitchesStmt, SimpleRef, SimpleRefOrLiteral, Skip1Stmt, Skip2Stmt, Skip3Stmt, SortStmt, SourceComputerParagraph, SourceFile, SpecialNamesParagraph, SpecialRegister, StartStmt, Stmt, StopLiteralStmt, StopRunStmt, StopStmt, StringClause, StringStmt, SubtractCorrStmt, SubtractFromGivingStmt, SubtractFromStmt, SubtractStmt, SwitchStatusCondition, SymbolicCharactersClause, SystemNamePhrase, TableDataItem, TableKeyInfo, TableRef, TableSubscript, TitleStmt, TopLevelVariable, TopLevelVariableSet, UnicodeEditedItem, UnicodeItem, UnitClause, UnstringDelimitedClause, UnstringDelimiter, UnstringIntoClause, UnstringStmt, UPSISwitch, UPSISwitchRef, UsageClause, UserDefinedCharacterClass, UseStmt, ValidatingClause, ValueOfClause, VariableTableDataItem, VaryingClause, WorkingStorageSection, WriteAdvancingClause, WriteStmt, XMLGenerateStmt, XMLParseStmt, XMLSchema

public interface ASTNode
extends org.eclipse.emf.ecore.EObject

The interface that is implemented by each node of the syntax tree in the COBOL model. This API provides access to the source location of the portion of the COBOL program represented by the node, as well as providing the parent node for the given node.

The following features are supported:

See Also:
COBOLPackage.getASTNode()

Field Summary
static java.lang.String copyright
           
 
Method Summary
 short getBeginColumn()
          Returns the value of the 'Begin Column' attribute.
 java.lang.String getBeginFile()
          Returns the value of the 'Begin File' attribute.
 int getBeginLine()
          Returns the value of the 'Begin Line' attribute.
 short getEndColumn()
          Returns the value of the 'End Column' attribute.
 java.lang.String getEndFile()
          Returns the value of the 'End File' attribute.
 int getEndLine()
          Returns the value of the 'End Line' attribute.
 ASTNode getParent()
          Returns the value of the 'Parent' reference.
 java.lang.String getTag()
          Returns the value of the 'Tag' attribute.
 void setBeginColumn(short value)
          Sets the value of the 'Begin Column' attribute.
 void setBeginFile(java.lang.String value)
          Sets the value of the 'Begin File' attribute.
 void setBeginLine(int value)
          Sets the value of the 'Begin Line' attribute.
 void setEndColumn(short value)
          Sets the value of the 'End Column' attribute.
 void setEndFile(java.lang.String value)
          Sets the value of the 'End File' attribute.
 void setEndLine(int value)
          Sets the value of the 'End Line' attribute.
 void setParent(ASTNode value)
          Sets the value of the 'Parent' reference.
 void setTag(java.lang.String value)
          Sets the value of the 'Tag' attribute.
 
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

getBeginColumn

short getBeginColumn()
Returns the value of the 'Begin Column' attribute.

The value is the column number of the beginning of the text of the part of the COBOL program represented by this node. The first column on a line is column 1.

Returns:
the value of the 'Begin Column' attribute.
See Also:
setBeginColumn(short), COBOLPackage.getASTNode_BeginColumn()

setBeginColumn

void setBeginColumn(short value)
Sets the value of the 'Begin Column' attribute.

Parameters:
value - the new value of the 'Begin Column' attribute.
See Also:
getBeginColumn()

getEndColumn

short getEndColumn()
Returns the value of the 'End Column' attribute.

The value is the column number of the end of the text of the part of the COBOL program represented by this node.

Returns:
the value of the 'End Column' attribute.
See Also:
setEndColumn(short), COBOLPackage.getASTNode_EndColumn()

setEndColumn

void setEndColumn(short value)
Sets the value of the 'End Column' attribute.

Parameters:
value - the new value of the 'End Column' attribute.
See Also:
getEndColumn()

getBeginFile

java.lang.String getBeginFile()
Returns the value of the 'Begin File' attribute.

The value is the name of the source file where the text begins for the part of the COBOL program represented by this node. The source file can be a copybook.

Returns:
the value of the 'Begin File' attribute.
See Also:
setBeginFile(String), COBOLPackage.getASTNode_BeginFile()

setBeginFile

void setBeginFile(java.lang.String value)
Sets the value of the 'Begin File' attribute.

Parameters:
value - the new value of the 'Begin File' attribute.
See Also:
getBeginFile()

getEndFile

java.lang.String getEndFile()
Returns the value of the 'End File' attribute.

The value is the name of the source file where the text ends for the part of the COBOL program represented by this node. The source file can be a copybook.

Returns:
the value of the 'End File' attribute.
See Also:
setEndFile(String), COBOLPackage.getASTNode_EndFile()

setEndFile

void setEndFile(java.lang.String value)
Sets the value of the 'End File' attribute.

Parameters:
value - the new value of the 'End File' attribute.
See Also:
getEndFile()

getBeginLine

int getBeginLine()
Returns the value of the 'Begin Line' attribute.

The value is the line number of the beginning of the text of the part of the COBOL program represented by the node. The first line in a source file is line 1.

Returns:
the value of the 'Begin Line' attribute.
See Also:
setBeginLine(int), COBOLPackage.getASTNode_BeginLine()

setBeginLine

void setBeginLine(int value)
Sets the value of the 'Begin Line' attribute.

Parameters:
value - the new value of the 'Begin Line' attribute.
See Also:
getBeginLine()

getEndLine

int getEndLine()
Returns the value of the 'End Line' attribute.

The value is the line number of the ending of the text of the part of the COBOL program represented by the node. The first line in a source program is line 1.

Returns:
the value of the 'End Line' attribute.
See Also:
setEndLine(int), COBOLPackage.getASTNode_EndLine()

setEndLine

void setEndLine(int value)
Sets the value of the 'End Line' attribute.

Parameters:
value - the new value of the 'End Line' attribute.
See Also:
getEndLine()

getTag

java.lang.String getTag()
Returns the value of the 'Tag' attribute.

The value is any additional information about the node not otherwise represented in the model.

Returns:
the value of the 'Tag' attribute.
See Also:
setTag(String), COBOLPackage.getASTNode_Tag()

setTag

void setTag(java.lang.String value)
Sets the value of the 'Tag' attribute.

Parameters:
value - the new value of the 'Tag' attribute.
See Also:
getTag()

getParent

ASTNode getParent()
Returns the value of the 'Parent' reference.

The value is the parent of this node in the syntax tree. For example, the parent of IdentificationDivision is Program

Returns:
the value of the 'Parent' reference.
See Also:
setParent(ASTNode), COBOLPackage.getASTNode_Parent()

setParent

void setParent(ASTNode value)
Sets the value of the 'Parent' reference.

Parameters:
value - the new value of the 'Parent' reference.
See Also:
getParent()