Process API

filenet.vw.api
Class VWIndexDefinition

java.lang.Object
  extended by filenet.vw.api.VWIndexDefinition
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public final class VWIndexDefinition
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Use this class to define an index that contains concatenated field names--names which consist of the exposed or system fields. Arrays are not allowed. These indices conserve resources when searching rosters, queues, and logs.

Since:
VWWS3.10
See Also:
Serialized Form

Method Summary
static java.lang.String _get_FILE_AUTHOR()
          For FileNet internal use only, do not call.
static java.lang.String _get_FILE_DATE()
          For FileNet internal use only, do not call.
static java.lang.String _get_FILE_REVISION()
          For FileNet internal use only, do not call.
 java.lang.String[] getAuthoredFieldNames()
          Returns the authored (untranslated) field names of the concatenated index.
 java.lang.String getAuthoredName()
          Gets the string containing the authored, untranslated name of the index field.
 java.lang.String[] getFieldNames()
          Returns the field names of the concatenated index.
 java.lang.String getName()
          Gets the index name associated with the index definition.
 boolean isMandatorySystemIndex()
          Indicates whether or not the index is a mandatory system index.
 boolean isSystemIndex()
          Indicates whether or not the index is a system index.
 void setFieldNames(java.lang.String[] theFieldNames)
          Sets the index definition to the specified field names.
 java.lang.String toString()
          Gets a string version of the VWIndexDefinition object.
 void toXML(java.lang.StringBuffer theBuffer)
          Appends an XML string representing this instance to the buffer specified.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

_get_FILE_DATE

public static java.lang.String _get_FILE_DATE()
For FileNet internal use only, do not call.

Returns:
the file date

_get_FILE_AUTHOR

public static java.lang.String _get_FILE_AUTHOR()
For FileNet internal use only, do not call.

Returns:
the file date

_get_FILE_REVISION

public static java.lang.String _get_FILE_REVISION()
For FileNet internal use only, do not call.

Returns:
the file date

getFieldNames

public java.lang.String[] getFieldNames()
Returns the field names of the concatenated index. If a translation source exists, the authored names are translated.

Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).

Returns:
A String array containing the translated field names, if a translation source exists; otherwise the authored names is returned. Null is returned if the index has no exposed fields.

Note: Certain system index fields are for internal use only and are not exposed.


getAuthoredFieldNames

public java.lang.String[] getAuthoredFieldNames()
Returns the authored (untranslated) field names of the concatenated index.

Returns:
A String array of the authored field names comprising the concatenated index, or null if the index does not have any exposed fields.

Note: Certain system index fields are not made visible and are for internal use only.


setFieldNames

public void setFieldNames(java.lang.String[] theFieldNames)
                   throws VWException
Sets the index definition to the specified field names. You must order the array so the field names reflect the sorting order, with the major index element as the first element in the array.

Parameters:
theFieldNames - The field names that define the concatenated index.
Throws:
VWException

getName

public java.lang.String getName()
Gets the index name associated with the index definition. If a translation source exists, the authored name is translated.

Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).

Returns:
A String containing the translated name, if a translation source exists; otherwise the authored name is returned.

toString

public java.lang.String toString()
Gets a string version of the VWIndexDefinition object.

Overrides:
toString in class java.lang.Object
Returns:
A string value that represents the index definition object.

getAuthoredName

public java.lang.String getAuthoredName()
                                 throws VWException
Gets the string containing the authored, untranslated name of the index field.

Returns:
The authored, untranslated name of the index.
Throws:
VWException

isSystemIndex

public boolean isSystemIndex()
Indicates whether or not the index is a system index.

Returns:
A boolean value: true if the index is a system index; otherwise, false.

isMandatorySystemIndex

public boolean isMandatorySystemIndex()
Indicates whether or not the index is a mandatory system index.

Returns:
A boolean value: true if the index is a mandatory system index; otherwise, false.

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML string representing this instance to the buffer specified.

Warning: This XML string is nonextensible, and cannot be modified in any way.

Parameters:
theBuffer - A StringBuffer that will be appended with the XML content.
Throws:
VWException - Thrown if the specified buffer is null.
See Also:
VWXMLUtil

Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.