Namespace: Consultingwerk.Studio
Class 
Annotation Copy to Clipboard
Parent classes:
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



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
CHARACTER FileName
INTEGER Line
CHARACTER Name
Progress.Lang.Object Node
Consultingwerk.ListNameValuePair Parameters


Method Detail
Top

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

ParseAnnotationParameters (character)

Purpose: Parses the List of Annotation Parameters
Notes: The list of parameters may be including or excluding the surrounding
parenthesis

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

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

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

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

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

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

INTEGER Column


Returns INTEGER
Top

CHARACTER FileName


Returns CHARACTER
Top

INTEGER Line


Returns INTEGER
Top

CHARACTER Name


Returns CHARACTER
Top

Progress.Lang.Object Node


Returns Progress.Lang.Object
Top

Consultingwerk.ListNameValuePair Parameters


Returns Consultingwerk.ListNameValuePair


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       13.04.2026 10:29:26