|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.DKTextIndexDefICM
Content Manager version 8 allows an administrator to make attributes text-searchable. In addition, the text content in the Resource Manager may also be made text searchable. For such searches to work in an optimal manner, a text search index must be define. The DKTextIndexICM class holds all the properties of a text search index in Content Manager. It contains set/get methods to set and query this information. It has no interaction with the server itself. An instance of this class may be specified when defining an attribute for a component. If this class is specified, it makes the attribute text searchable. Conversely, setting the value of the instance of this class associated with the attribute to null makes the attribute non text-searchable. An instance of this class may also be used to specify the text index properties for a Text Resource Item Type.
Field Summary | |
static java.lang.String |
TEXT_INDEX_DOC_FORMAT_GPP
Constant to specify gpp format for indexed documents. |
static java.lang.String |
TEXT_INDEX_DOC_FORMAT_HTML
Constant to specify html format for indexed documents. |
static java.lang.String |
TEXT_INDEX_DOC_FORMAT_TEXT
Constant to specify text format for indexed documents. |
static java.lang.String |
TEXT_INDEX_DOC_FORMAT_XML
Constant to specify xml format for indexed documents. |
Constructor Summary | |
DKTextIndexDefICM()
Default constructor. |
|
DKTextIndexDefICM(DKTextIndexDefICM attr)
Copy constructor for the text index definition class. |
Method Summary | |
int |
getCommitCount()
Retrieves the commit count for this text index. |
java.lang.String |
getFormat()
Retrieves the format of text documents in the index. |
int |
getIndexCCSID()
Gets CCSID used for building a text index. |
java.lang.String |
getIndexDir()
Retrieves the name/value for the directory on the server where the text index is to be stored. |
java.lang.String |
getIndexLangCode()
Retrieves the language code for theis text index. |
int |
getMinChanges()
Retrieves the minimum number of changes to the text column that may occur before this text index is updated automatically. |
int |
getModelCCSID()
Retrieves the model CCSID of the model file associated with this text index. |
java.lang.String |
getModelFile()
Retrieves the model file for the model associated with this text index. |
java.lang.String |
getModelName()
Retrieves the model name for this text index. |
java.lang.String |
getUDFName()
Gets the name of a user defined Function (UDF) that will be used to fetch or filter the content that are indexed. |
java.lang.String |
getUDFSchema()
Retrieves the schema of the user defined function(UDF) associated with tis text index. |
java.lang.String |
getUpdateFrequency()
Retrieves the update frequency for this text index. |
java.lang.String |
getWorkingDir()
Retrieves the working directory for this text index. |
void |
setCommitCount(int commitCount)
Sets the commit count for this text index. |
void |
setFormat(java.lang.String format)
Sets the format of the text documents associated with this text index. |
void |
setIndexCCSID(int indexCCSID)
Sets the CCSID used for building this text index. |
void |
setIndexDir(java.lang.String indexDir)
Sets the value for the directory on the server where the text index is to be stored. |
void |
setIndexLangCode(java.lang.String indexLangCode)
Sets the language code for the text index. |
void |
setMinChanges(int minChanges)
Sets the minimum number of changes to the text column that may occur before the text index is updated automaticially. |
void |
setModelCCSID(int modelCCSID)
Sets the model CCSID of the model file associated with this text index. |
void |
setModelFile(java.lang.String modelFile)
Sets the value for the model file associated with this text index. |
void |
setModelName(java.lang.String modelName)
Sets the name of the model associated with this text index. |
void |
setUDFName(java.lang.String udfName)
Sets the name of a user defined Function (UDF) that will be used to fetch or filter the content that is indexed. |
void |
setUDFSchema(java.lang.String udfSchema)
Sets the schema of the user defined Function(UDF). |
void |
setUpdateFrequency(java.lang.String updateFreq)
Sets the value for the update frequency for this text index. |
void |
setWorkingDir(java.lang.String workingDir)
Sets the value of the working directory for this text index. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static java.lang.String TEXT_INDEX_DOC_FORMAT_TEXT
public static java.lang.String TEXT_INDEX_DOC_FORMAT_HTML
public static java.lang.String TEXT_INDEX_DOC_FORMAT_XML
public static java.lang.String TEXT_INDEX_DOC_FORMAT_GPP
Constructor Detail |
public DKTextIndexDefICM()
public DKTextIndexDefICM(DKTextIndexDefICM attr)
attr
- - DKTextIndexDefICM object to use as a template for creating the new object.Method Detail |
public int getIndexCCSID()
public void setIndexCCSID(int indexCCSID)
indexCCSID
- - the CCSID that will be used for building this text index.public java.lang.String getIndexLangCode()
public void setIndexLangCode(java.lang.String indexLangCode)
languageCode
- - value to set the language code of the text index to.public int getMinChanges()
public void setMinChanges(int minChanges)
minChanges
- - the value to set for the minimum number of changes
to occur to the text column before an automatic update of this text indexpublic java.lang.String getUpdateFrequency()
public void setUpdateFrequency(java.lang.String updateFreq)
updateFreq
- - value to set the update frequency for this text index to.public int getCommitCount()
public void setCommitCount(int commitCount)
commitCount
- - new value for the number of rows to process
before a commit is executedpublic java.lang.String getFormat()
public void setFormat(java.lang.String format)
format
- - new value for the format of text documents associated
with this text index.public java.lang.String getIndexDir()
public void setIndexDir(java.lang.String indexDir)
value/name
- for a directory on the server where the index data is to be stored.public java.lang.String getWorkingDir()
public void setWorkingDir(java.lang.String workingDir)
workingDir
- - value for the working directory where temporary
files created during the indexing process of this text index will be stored.public java.lang.String getModelName()
public void setModelName(java.lang.String modelName)
modelName
- - name of the model to be associated with this text indexpublic java.lang.String getModelFile()
public void setModelFile(java.lang.String modelFile)
modelFile
- - value for the model file for the model associated
with this text indexpublic int getModelCCSID()
public void setModelCCSID(int modelCCSID)
modelCCSID
- - value for the CCSID used for the model file.public java.lang.String getUDFName()
public void setUDFName(java.lang.String udfName)
udfName
- - value for the UDF name that will be used to
generate indexable content associated with this text index.public java.lang.String getUDFSchema()
public void setUDFSchema(java.lang.String udfSchema)
udfSchema
- - value for the UDF Schema associated with this text index.
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |