MetadataI Class Reference

Inheritance diagram for MetadataI:

Collaboration diagram for MetadataI:

Static Public Member Functions
_.Library.Integer	AddField (_.Library.Integer domainId, _.Library.String fieldName, _.Library.List supportedOperators, _.Library.String dataType, _.Library.Integer storage, _.Library.Boolean caseSensitive, _.Library.Integer lovId, _.Library.Boolean validateLov, _.Library.Boolean hidden)
_.iKnow.Filters.Filter	CreateFilter (_.Library.Integer pDomainId, _.Library.String pFieldName, _.Library.String pOperator, _.Library.String pValue, _.Library.Status pSC)
	Create a <class>iKnow.Filters.Filter</class> instance that filters sources according to. More...
_.Library.Status	EndBatch (_.Library.Integer domainId)
_.Library.Integer	GetFieldId (_.Library.Integer domainId, _.Library.String fieldName)
	Returns the metadata field ID corresponding to the supplied name, or "" if none exists in this domain.
_.Library.Status	GetFields (_.Library.Integer result, _.Library.Integer domainId, _.Library.Boolean includeHidden)
_.Library.String	GetValue (_.Library.Integer domainId, _.Library.String fieldName, _.Library.String externalId, _.Library.Status sc)
	Returns the actual value for a given metadata field (by name) and source (by External ID).
_.Library.String	GetValueById (_.Library.Integer domainId, _.Library.Integer fieldId, _.Library.Integer srcId, _.Library.Status sc)
	Returns the actual value for a given metadata field (by ID) and source (by Source ID).
_.Library.Status	SetValue (_.Library.Integer domainId, _.Library.String fieldName, _.Library.String externalId, _.Library.String value)
_.Library.Status	SetValueById (_.Library.Integer domainId, _.Library.Integer fieldId, _.Library.Integer srcId, _.Library.String value)
_.Library.Status	StartBatch (_.Library.Integer domainId)

Static Public Attributes
	GetFieldsRT = None
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...

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...

Detailed Description

This is the interface to interact with metadata as expected by other parts of the iKnow libraries. A simple but flexible implementation is provided through <class>iKnow.Queries.MetadataAPI</class>, but customers can choose to develop their own or wire to an existing metadata infrastructure by implementing the interface specified in this class.

Member Function Documentation

AddField()

_.Library.Integer AddField ( _.Library.Integer  domainId, _.Library.String  fieldName, _.Library.List  supportedOperators, _.Library.String  dataType, _.Library.Integer  storage, _.Library.Boolean  caseSensitive, _.Library.Integer  lovId, _.Library.Boolean  validateLov, _.Library.Boolean  hidden  )

static

Adds a field definition with the given name and properties.

• The supportedOperators parameter specifies which operations (such as $$$MDOPEQUAL) will be available for filtering criteria
• For dataType, choose either $$$MDDTSTRING, $$$MDDTNUMBER or $$$MDDTDATE ($horolog format)
• Use storage to control the way how values are stored: $$$MDSTNORMAL for cases where you would use a normal index, $$$MDSTBITMAP where you would use a bitmap index (few different metadata values compared to total # of records)
• If dataType is $$$MDDTSTRING, caseSensitive controls whether or not string values should be treated as case-sensitive.
• The lovId and validateLov parameters define wheter a List Of Values is available for this metadata field and whether input values should be verified against this list. See also <method>AddListOfValues</method>.
• If hidden is set to true, the field will by default not appear in metadata field and value lists.

Reimplemented in MetadataAPI.

CreateFilter()

_.iKnow.Filters.Filter CreateFilter ( _.Library.Integer  pDomainId, _.Library.String  pFieldName, _.Library.String  pOperator, _.Library.String  pValue, _.Library.Status  pSC  )

static

Create a <class>iKnow.Filters.Filter</class> instance that filters sources according to.

the given criteria, using the filter class compatible with this <class>iKnow.Queries.MetadataI</class> implementation.

Reimplemented in MetadataAPI, and MetadataAPI.

EndBatch()

_.Library.Status EndBatch ( _.Library.Integer  domainId )

static

Ends a metadata batch. See <method>StartBatch</method> for more details.

Reimplemented in MetadataAPI, and MetadataAPI.

GetFields()

_.Library.Status GetFields ( _.Library.Integer  result, _.Library.Integer  domainId, _.Library.Boolean  includeHidden  )

static

Returns all field definitions (including their properties) for the given domain.

Reimplemented in MetadataAPI, and MetadataAPI.

SetValue()

_.Library.Status SetValue ( _.Library.Integer  domainId, _.Library.String  fieldName, _.Library.String  externalId, _.Library.String  value  )

static

Sets (or replaces if it exists) the value for a given metadata field (by name) for a given source

(by External ID).

Values for fields of type $$$MDDTSTRING are normalized and stripped of whitespace and control characters at the beginning and end of the string.

Reimplemented in MetadataAPI, and MetadataAPI.

SetValueById()

_.Library.Status SetValueById ( _.Library.Integer  domainId, _.Library.Integer  fieldId, _.Library.Integer  srcId, _.Library.String  value  )

static

Sets (or replaces if it exists) the value for a given metadata field (by ID) for a given source

(by Source ID).

Values for fields of type $$$MDDTSTRING are normalized and stripped of whitespace and control characters at the beginning and end of the string.

Reimplemented in MetadataAPI, and MetadataAPI.

StartBatch()

_.Library.Status StartBatch ( _.Library.Integer  domainId )

static

Starts a 'batch' during which metadata values can be set. Some setting operations and index

recalculations are optimized for batch processing.

NOTE: It is currently up to the user to make sure no metadata values are read during the batch and no values exist already (as replacing a value involves reading it). Reading metadata field values during a batch is not guaranteed to return correct results.

Reimplemented in MetadataAPI, and MetadataAPI.

Member Data Documentation

GetFieldsRT

GetFieldsRT = None

static

This is the interface to interact with metadata as expected by other parts of the iKnow libraries. A simple but flexible implementation is provided through <class>iKnow.Queries.MetadataAPI</class>, but customers can choose to develop their own or wire to an existing metadata infrastructure by implementing the interface specified in this class.