Home > Class Reference > %SYS namespace > %iKnow.Model.listQuery

%iKnow.Model.listQuery

class %iKnow.Model.listQuery extends %iKnow.Model.list

Subclass of %iKnow.Model.list dedicated to represent lists for the SQL Lister. This class has its own set of properties representing the specific Lister paramaters of the SQL Lister and hence is more easy to use than the generic list class. Any <parameter> elements nested within this element will be overwritten with the values specified for the corresponding shorthand attributes.

See also %iKnow.Source.SQL.Lister for more details on these Lister Parameters.

Property Inventory

Parameters

parameter XMLNAME = query;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties

property dataFields as %String (MAXLEN = 250, XMLPROJECTION = "attribute");
The column names selected by query containing the actual data to be indexed.
Property methods: dataFieldsDisplayToLogical(), dataFieldsGet(), dataFieldsIsValid(), dataFieldsLogicalToDisplay(), dataFieldsLogicalToOdbc(), dataFieldsNormalize(), dataFieldsSet()
property groupField as %String (MAXLEN = 250, XMLPROJECTION = "attribute");
The column name selected by query containing the group name to use for constructing the external ID for a loaded source.
Property methods: groupFieldDisplayToLogical(), groupFieldGet(), groupFieldIsValid(), groupFieldLogicalToDisplay(), groupFieldLogicalToOdbc(), groupFieldNormalize(), groupFieldSet()
property idField as %String (MAXLEN = 250, XMLPROJECTION = "attribute");
The column name selected by query containing the local reference to use for constructing the external ID for a loaded source.
Property methods: idFieldDisplayToLogical(), idFieldGet(), idFieldIsValid(), idFieldLogicalToDisplay(), idFieldLogicalToOdbc(), idFieldNormalize(), idFieldSet()
property listerClass as %String (MAXLEN = 250, XMLPROJECTION = "attribute") [ InitialExpression = "%iKnow.Source.SQL.Lister" , ReadOnly ];
Inherited description: The Lister class to use for loading data defined in this list element. This class should extend %iKnow.Source.Lister. The Lister class defined here dictates the contents of the parameters property.
Property methods: listerClassDisplayToLogical(), listerClassGet(), listerClassIsValid(), listerClassLogicalToDisplay(), listerClassLogicalToOdbc(), listerClassNormalize(), listerClassSet()
property metadataColumns as %String (MAXLEN = 1000, XMLPROJECTION = "attribute");
The column names selected by query containing any metadata values to be stored with loaded sources.
Property methods: metadataColumnsDisplayToLogical(), metadataColumnsGet(), metadataColumnsIsValid(), metadataColumnsLogicalToDisplay(), metadataColumnsLogicalToOdbc(), metadataColumnsNormalize(), metadataColumnsSet()
property metadataFields as %String (MAXLEN = 1000, XMLPROJECTION = "attribute");
The names of the metadata fields positionally corresponding to the columns identified in metadataColumns. If left empty, the column names in metadataColumns are expected to correspond to metadata field names themselves.
Property methods: metadataFieldsDisplayToLogical(), metadataFieldsGet(), metadataFieldsIsValid(), metadataFieldsLogicalToDisplay(), metadataFieldsLogicalToOdbc(), metadataFieldsNormalize(), metadataFieldsSet()
property sql as %String (MAXLEN = 2000, XMLPROJECTION = "attribute");
The query to run for retrieving sources to process.
Property methods: sqlDisplayToLogical(), sqlGet(), sqlIsValid(), sqlLogicalToDisplay(), sqlLogicalToOdbc(), sqlNormalize(), sqlSet()

Inherited Members

Inherited Properties

Inherited Methods