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

Public Attributes

 beginSubscript
 The subscript to start from (default "") More...
 
 endSubscript
 End subscript (default "") More...
 
 filterCondition
 If set, this COS expression is called using xecute command for every node visited by the. More...
 
 globalReference
 The global containing the data to be indexed. More...
 
 globalType
 How the textual data in the global nodes between <property>beginSubscript</property> and. More...
 
 listerClass
   More...
 
 metadataFields
 For <property>globalType</property> = 2 only, a comma-separated list of metadata fields stored in the top node. More...
 
 separator
 Separator to add between nodes if <property>globalType</property> is 1 or 2. More...
 
- Public Attributes inherited from list
 batchMode
 Whether or not to load the data in this list in batch mode. More...
 
 configuration
 The name of the <class>iKnow.Configuration</class> object to use when loading data from this. More...
 
 converter
 The converter to be used when loading data from this list. More...
 
 data
 The data wrapper this list belongs to. More...
 
 disabled
 If set to 1, this list is not included in the Build() method. More...
 
 listerClass
 The Lister class to use for loading data defined in this list element. More...
 
 listname
   More...
 
 metadataValues
 Any fixed metadata values to register for each source in the following list definitons. More...
 
 processor
 The processor to be used when loading data from this list. More...
 
- Public Attributes inherited from nodeWithParameters
 parameters
   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...
 
- Public Member Functions inherited from Adaptor
_.Library.Status XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
 Serialize an XML enabled class as an XML document and write. More...
 
_.Library.Status XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and appends it to a stream. More...
 
_.Library.Status XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and write it to a string. More...
 
- Static Public Member Functions inherited from Adaptor
_.Library.Status XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
 Write the DTD to the current device for this XML enabled class serialized as. More...
 
_.Library.RegisteredObject XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
 Get an instance of an XML enabled class. More...
 
_.Library.Status XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
 Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...
 
_.Library.String XMLSchemaNamespace ()
 Get the namespace to which this class belongs for use in schema generation. More...
 
_.Library.Status XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
 Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...
 
- Static Public Attributes inherited from abstractNode
 XMLINCLUDEINGROUP = None
 Do not include this class in the XML groupings.
 
- 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...
 
- Static Public Attributes inherited from Adaptor
 ATTRIBUTEQUALIFIED = None
 ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...
 
 ELEMENTQUALIFIED = None
 ELEMENTQUALIFIED controls the format of exported XML. More...
 
 NAMESPACE = None
 NAMESPACE specifies the XML namespace to be used when projecting the. More...
 
 SUPPRESSTYPEPREFIX = None
 SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...
 
 XMLDEFAULTREFERENCE = None
 XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...
 
 XMLENABLED = None
 If this parameter is true then XML-enabling methods. More...
 
 XMLFORMAT = None
 The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...
 
 XMLIGNOREINVALIDATTRIBUTE = None
 The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNOREINVALIDTAG = None
 The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNORENULL = None
 XMLIGNORENULL allows the programmer to override the default XML handling. More...
 
 XMLINCLUDEINGROUP = None
 XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...
 
 XMLINHERITANCE = None
 If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...
 
 XMLNAME = None
 This parameter provides the default XMLNAME for the class. More...
 
 XMLNIL = None
 The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...
 
 XMLNILNOOBJECT = None
 The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...
 
 XMLPREFIX = None
 The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...
 
 XMLSEQUENCE = None
 If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...
 
 XMLSUMMARY = None
 The summary fields to be used when an object is referenced are specified. More...
 
 XMLTYPE = None
 This parameter provides the default XMLTYPE for the class. More...
 
 XMLUNSWIZZLE = None
 If the XMLUNSWIZZLE parameter is set to 1, then single object. More...
 
 XMLUSEEMPTYELEMENT = None
 If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...
 

Detailed Description

Subclass of <class>iKnow.Model.list</class> dedicated to represent lists for the Global Lister. This class has its own set of properties representing the specific Lister paramaters of the Global 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 <class>iKnow.Source.Global.Lister</class> for more details on these Lister Parameters.

Member Data Documentation

◆ beginSubscript

beginSubscript

The subscript to start from (default "")

 

◆ endSubscript

endSubscript

End subscript (default "")

 

◆ filterCondition

filterCondition

If set, this COS expression is called using xecute command for every node visited by the.

Global Lister. If it returns false, the node is skipped.  

◆ globalReference

globalReference

The global containing the data to be indexed.

 

◆ globalType

globalType

How the textual data in the global nodes between <property>beginSubscript</property> and.

<property>endSubscript</property> is stored. Either of the following:

  • 0 - single node (default)
  • 1 - top node has count with subnodes 1..n having data
  • 2 - top node has metadata, subnodes 1..n have data

 

◆ listerClass

listerClass

 

 

◆ metadataFields

metadataFields

For <property>globalType</property> = 2 only, a comma-separated list of metadata fields stored in the top node.

 

◆ separator

separator

Separator to add between nodes if <property>globalType</property> is 1 or 2.

Defaults to "".