This class contains the APIs for DeepSee Term Lists. More...

Inheritance diagram for TermList:

[legend]

Collaboration diagram for TermList:

[legend]

Static Private Member Functions
_.Library.Status	CreateTermList (_.Library.String pTermList, _.Library.String pCaption, _.Library.String pFieldList, _.Library.String pPattern, _.Library.String pDescription, _.Library.String pSubjectArea, _.Library.Boolean pHideValue)
	Create (or update if present) the given term list. More...

_.Library.Status	DeleteTermList (_.Library.String pTermList)
	Delete the specified term list.

_.Library.Status	ExportCSV (_.Library.String pTermList, _.Library.String pFileName, _.Library.Boolean pIncludeEncoding)
	Export a TermList to the CSV-file, pFileName. More...

_.Library.Status	GetTermLists (_.Library.List pList)
	Get a list of currently defined term lists. More...

_.Library.Status	GetValueArray (_.Library.String pTermList, _.Library.String pArray, _.Library.String pField)
	Lookup all values (the "value" field) from the term list pTermList and copy them into a local array. More...

_.Library.Status	ImportCSV (_.Library.String pFileName, _.Library.String pTermListName, _.Library.Boolean pVerbose)
	Load a TermList from the CSV-file, pFileName. More...

_.Library.String	Lookup (_.Library.String pTermList, _.Library.String pKey, _.Library.String pField, _.Library.String pDefault)
	Lookup a single value within the term list pTermList. More...

	ParseCSVRecord (_.Library.String pText, pValues)
	Parse a CSV record and split it into an ordinally index array.

_.Library.Status	SetValue (_.Library.String pTermList, _.Library.String pKey, _.Library.String pValue, _.Library.String pField)
	Set a value within the term list pTermList More...

_.Library.Boolean	TermListExists (_.Library.String pTermList, _.Library.Status pSC)
	Test if the given term list exists.

	WriteCSVRecord (pRecord, _.Library.Boolean pEncode)
	Write out the contents of the integer-indexed array pRecord in csv format. 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...

Detailed Description

This class contains the APIs for DeepSee Term Lists.

A Term List is a simple lookup table that can be used to translate values when creating DeepSee models or can be referenced at run-time.

Member Function Documentation

◆ CreateTermList()

_.Library.Status CreateTermList	(	_.Library.String	pTermList,
		_.Library.String	pCaption,
		_.Library.String	pFieldList,
		_.Library.String	pPattern,
		_.Library.String	pDescription,
		_.Library.String	pSubjectArea,
		_.Library.Boolean	pHideValue
	)

staticprivate

Create (or update if present) the given term list.

pTermList is the name of the term list.
pCaption is the optional caption (display name) of the term list.
pFieldList is an optional ^-delimited list of fields.
pPattern is an optional pattern to apply to the "value" field.
pDescription is the description of the term list.
pSubjectArea is the optional name of the subject area the term list applies to.

◆ ExportCSV()

_.Library.Status ExportCSV	(	_.Library.String	pTermList,
		_.Library.String	pFileName,
		_.Library.Boolean	pIncludeEncoding
	)

staticprivate

Export a TermList to the CSV-file, pFileName.

The meta-data for the term list is written to the starting lines of the file using %% as a prefix for key values.

WAL044 – add pIncludeEncoding; this is not needed in DeepSee.UI.TermListExport

◆ GetTermLists()

_.Library.Status GetTermLists ( _.Library.List pList )

staticprivate

Get a list of currently defined term lists.

This is returned as:

pList(NAME) = $LB(name,caption,moddate,type)

◆ GetValueArray()

_.Library.Status GetValueArray	(	_.Library.String	pTermList,
		_.Library.String	pArray,
		_.Library.String	pField
	)

staticprivate

Lookup all values (the "value" field) from the term list pTermList and copy them into a local array.

The output is:
pArray(key) = value
If pField is supplied, then use the value of that field.

◆ ImportCSV()

_.Library.Status ImportCSV	(	_.Library.String	pFileName,
		_.Library.String	pTermListName,
		_.Library.Boolean	pVerbose
	)

staticprivate

Load a TermList from the CSV-file, pFileName.

The first value on each line is used as a key value, the second as the "value" field. All other values are ignored unless there is a field list defined. In this case, the field list determines how the values within each record are used.
If pTermListName is supplied, use it. Otherwise use the %NAME field found in the file.
If pFileName is a stream, then import from it. WAL041 – pTermListName is returned

◆ Lookup()

_.Library.String Lookup	(	_.Library.String	pTermList,
		_.Library.String	pKey,
		_.Library.String	pField,
		_.Library.String	pDefault
	)

staticprivate

Lookup a single value within the term list pTermList.

pKey is the unique key for the item in the term list.
pField is the name of the value field to use; if not supplied, "value" is used.
pDefault is a value to return if the key or property value do not exist.
If the termlist has a pattern associated with it, and the requested field is the "value" field, then the pattern is applied to value before it is returned.

◆ SetValue()

_.Library.Status SetValue	(	_.Library.String	pTermList,
		_.Library.String	pKey,
		_.Library.String	pValue,
		_.Library.String	pField
	)

staticprivate

Set a value within the term list pTermList

using the given key value. If pField is provided, then set the value of that field.

◆ WriteCSVRecord()

WriteCSVRecord	(		pRecord,
		_.Library.Boolean	pEncode
	)

staticprivate

Write out the contents of the integer-indexed array pRecord in csv format.

There should be no gaps in the array.

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateTermList()

◆ ExportCSV()

◆ GetTermLists()

◆ GetValueArray()

◆ ImportCSV()

◆ Lookup()

◆ SetValue()

◆ WriteCSVRecord()