Namespace: Consultingwerk.Studio
Class 
Annotation Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Studio.Annotation

Inherits: Progress.Lang.Object

File:Annotation
Purpose:Value class for the result of the AnnotationParser
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Jan 27 22:32:16 CET 2013

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
# CHARACTER GetAnnotationName (JPNode) Returns the Annotation Name
# ParseAnnotationParameters (character) Parses the List of Annotation Parameters
# ParseAnnotationParameters (JPNode) Parses the List of Annotation Parameters

Top Constructor Summary
Options Name Purpose
+ Annotation (character, character, character, integer, integer) Constructor for the Annotation class
+ Annotation (character, character, integer, integer) Constructor for the Annotation class
+ Annotation (character, integer, integer, JPNode) Constructor for the Annotation class
+ Annotation (JPNode) Constructor for the Annotation class

Top Property Summary
Options Name Purpose
+ INTEGER Column Returns the Column number containing the Annotation
+ CHARACTER FileName Returns the FileName containing the Annotation
+ INTEGER Line Returns the Line number containing the Annotation
+ CHARACTER Name Returns the Name of the Annotation
+ Progress.Lang.Object Node Returns the reference to the JPNode of the Annotation
+ Consultingwerk.ListNameValuePair Parameters Returns the List of Annotation Parameters


Method Detail
Top

PROTECTED CHARACTER GetAnnotationName (JPNode)
Purpose: Returns the Annotation Name
Notes: Returns the JPNode's text and concatenates any occurences of ID namedot/id nodes

Parameters:
poNode org.prorefactor.core.JPNode
The JPNode to return the annotation's name from
Returns CHARACTER
The Annotation Name
Top

PROTECTED ParseAnnotationParameters (character)
Purpose: Parses the List of Annotation Parameters
Notes: The list of parameters may be including or excluding the surrounding
paranthesis

Parameters:
pcParameters CHARACTER
The list of annotation parameters as a characer string
Top

PROTECTED ParseAnnotationParameters (JPNode)
Purpose: Parses the List of Annotation Parameters
Notes:

Parameters:
poNode org.prorefactor.core.JPNode
The JPNode reference of the Annotation


Constructor Detail
Top

PUBLIC Annotation (character, character, character, integer, integer)
Purpose: Constructor for the Annotation class
Notes:

Parameters:
pcFileName CHARACTER
The file name containing the annotation
pcName CHARACTER
The name of the Annotation (including @)
pcParameter CHARACTER
The parameter list of the annotation (typically in parenthesis)
piLine INTEGER
The line number of the Annotation
piColumn INTEGER
The column number of the Annotation
Top

PUBLIC Annotation (character, character, integer, integer)
Purpose: Constructor for the Annotation class
Notes:

Parameters:
pcFileName CHARACTER
The file name containing the annotation
pcName CHARACTER
The name of the Annotation (including @)
piLine INTEGER
The line number of the Annotation
piColumn INTEGER
The column number of the Annotation
Top

PUBLIC Annotation (character, integer, integer, JPNode)
Purpose: Constructor for the Annotation class
Notes:

Parameters:
pcFileName CHARACTER
The file name containing the annotation
piLine INTEGER
The line number of the Annotation
piColumn INTEGER
The column number of the Annotation
poNode org.prorefactor.core.JPNode
The reference to the JPNode for the annotation
Top

PUBLIC Annotation (JPNode)
Purpose: Constructor for the Annotation class
Notes:

Parameters:
poNode org.prorefactor.core.JPNode
The reference to the JPNode for the annotation


Property Detail
Top

PUBLIC INTEGER Column
Purpose: Returns the Column number containing the Annotation
Notes:

Returns INTEGER
Top

PUBLIC CHARACTER FileName
Purpose: Returns the FileName containing the Annotation
Notes:

Returns CHARACTER
Top

PUBLIC INTEGER Line
Purpose: Returns the Line number containing the Annotation
Notes:

Returns INTEGER
Top

PUBLIC CHARACTER Name
Purpose: Returns the Name of the Annotation
Notes:

Returns CHARACTER
Top

PUBLIC Progress.Lang.Object Node
Purpose: Returns the reference to the JPNode of the Annotation
Notes: This property is of type Progress.Lang.Object and not JPNode to
allow reuse on platforms where Proparse is not accessible (UNIX)

Returns Progress.Lang.Object
Top

PUBLIC Consultingwerk.ListNameValuePair Parameters
Purpose: Returns the List of Annotation Parameters
Notes:

Returns Consultingwerk.ListNameValuePair


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:45:01