Process Class Relationships

filenet.vw.api
Class VWIndexDefinition

java.lang.Object
  |
  +--filenet.vw.api.VWIndexDefinition
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

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
 java.lang.String[] getFieldNames()
          Returns 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. 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.
 java.lang.String toString()
          Gets a string version of the VWIndexDefinition object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getFieldNames

public java.lang.String[] getFieldNames()
Returns field names of the concatenated index.
Returns:
An array of field names comprising the concatenated index or null if the index does not have any visible 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.
Returns:
The name of the index definition.

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.

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.

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.