IRISLIB database
TextServices Class Reference
Inheritance diagram for TextServices:
Collaboration diagram for TextServices:

Static Public Member Functions

_.Library.Status GetTextAsArray (_.Library.String pNamespace, _.Library.String pClassName, _.Library.String pDocumentText)
 This method takes a namespace and the name of a class and on success returns an integer subscripted array of text. More...
 
_.Library.Status GetTextAsFile (_.Library.String pNamespace, _.Library.String pClassName, _.Library.String pFileName)
 This method takes a namespace, classname and a file name. More...
 
_.Library.Status GetTextAsStream (_.Library.String pNamespace, _.Library.String pClassName, _.Stream.Object pTextStream)
 This method takes namespace and a classname and returns a character stream containing text which represents a. More...
 
_.Library.Status GetTextAsString (_.Library.String pNamespace, _.Library.String pClassName, _.Library.String pTextString, _.Library.String pDelimiter)
 This method takes a namespace and a classname and returns a string which represnts the class definition in the UDL. More...
 
_.Library.Status SetTextFromArray (_.Library.String pNamespace, _.Library.String pClassname, _.Library.String pDocumentArray)
 This method takes a namespace an integer subscripted array containing lines of text which represent a. More...
 
_.Library.Status SetTextFromFile (_.Library.String pNamespace, _.Library.String pClassName, _.Library.String pFileName)
 This method takes the namespace and a name of a file which contains text representing a class definition in the UDL. More...
 
_.Library.Status SetTextFromStream (_.Library.String pNamespace, _.Library.String pClassname, _.Library.CharacterStream pTextStream)
 This method takes a namespace and a stream of text which represents a class definition in the UDL class definition language. More...
 
_.Library.Status SetTextFromString (_.Library.String pNamespace, _.Library.String pClassname, _.Library.String pTextString, _.Library.String pDelimiter)
 This method takes a namespace and a string of text which represents a class definition in the UDL class definition language. More...
 

Additional Inherited Members

- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Member Function Documentation

◆ GetTextAsArray()

_.Library.Status GetTextAsArray ( _.Library.String  pNamespace,
_.Library.String  pClassName,
_.Library.String  pDocumentText 
)
static

This method takes a namespace and the name of a class and on success returns an integer subscripted array of text.

representing the class definition. The 0 node contains the number of lines of text (n) and each line of source is stored at the nodes 1 .. n.

◆ GetTextAsFile()

_.Library.Status GetTextAsFile ( _.Library.String  pNamespace,
_.Library.String  pClassName,
_.Library.String  pFileName 
)
static

This method takes a namespace, classname and a file name.

On success writes it to the named file

the text which represents a class definition in the UDL class definition language.

◆ GetTextAsStream()

_.Library.Status GetTextAsStream ( _.Library.String  pNamespace,
_.Library.String  pClassName,
_.Stream.Object  pTextStream 
)
static

This method takes namespace and a classname and returns a character stream containing text which represents a.

class definition in the UDL class definition language.

Note: you should supply your own instance of a character stream to write to. If you don't supply one then a new instance of a Stream.GlobalCharacter will be created and used

◆ GetTextAsString()

_.Library.Status GetTextAsString ( _.Library.String  pNamespace,
_.Library.String  pClassName,
_.Library.String  pTextString,
_.Library.String  pDelimiter 
)
static

This method takes a namespace and a classname and returns a string which represnts the class definition in the UDL.

class definition language

◆ SetTextFromArray()

_.Library.Status SetTextFromArray ( _.Library.String  pNamespace,
_.Library.String  pClassname,
_.Library.String  pDocumentArray 
)
static

This method takes a namespace an integer subscripted array containing lines of text which represent a.

class definition in the UDL class definition language. Subscript value 0 should contain a count of lines of text which are defined as subscript value 1 ... n in the array

The method will parse the class representation and if it is syntactically valid will attempt to save the class definition. It returns $$$OK on success and a (possibly composite) error status on failure. Note: a syntactically valid class represention may fail to save due to failure to obtain a lock.

It is important to realize that this method will replace the existing class definition if present and therefore must contain a full representation of the class as can be obtained by calling the GetClassXXX() method(s) in this class. Note: The name of the class is derived from the name of the class defined within the text

◆ SetTextFromFile()

_.Library.Status SetTextFromFile ( _.Library.String  pNamespace,
_.Library.String  pClassName,
_.Library.String  pFileName 
)
static

This method takes the namespace and a name of a file which contains text representing a class definition in the UDL.

class definition language.

The method will parse the class representation and if it is syntactically valid will attempt to save the class definition. It returns $$$OK on success and a (possibly composite) error status on failure. Note: a syntactically valid class represention may fail to save due to failure to obtain a lock.

It is important to realize that this method will replace the existing class definition if present and therefore must contain a full representation of the class as can be obtained by calling the GetTextXXX() method(s) in this class. Note: The name of the class is derived from the name of the class defined within the text

◆ SetTextFromStream()

_.Library.Status SetTextFromStream ( _.Library.String  pNamespace,
_.Library.String  pClassname,
_.Library.CharacterStream  pTextStream 
)
static

This method takes a namespace and a stream of text which represents a class definition in the UDL class definition language.

The method will parse the class representation and if it is syntactically valid will attempt to save the class definition. It returns $$$OK on success and a (possibly composite) error status on failure. Note: a syntactically valid class represention may fail to save due to failure to obtain a lock.

It is important to realize that this method will replace the existing class definition if present and therefore must contain a full representation of the class as can be obtained by calling the GetClassXXX() method(s) in this class. Note: The name of the class is derived from the name of the class defined within the text

◆ SetTextFromString()

_.Library.Status SetTextFromString ( _.Library.String  pNamespace,
_.Library.String  pClassname,
_.Library.String  pTextString,
_.Library.String  pDelimiter 
)
static

This method takes a namespace and a string of text which represents a class definition in the UDL class definition language.

The method will parse the class representation and if it is syntactically valid will attempt to save the class definition. It returns $$$OK on success and a (possibly composite) error status on failure. Note: a syntactically valid class represention may fail to save due to failure to obtain a lock.

It is important to realize that this method will replace the existing class definition if present and therefore must contain a full representation of the class as can be obtained by calling the GetClassXXX() method(s) in this class. Note: The name of the class is derived from the name of the class defined within the text