|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.autonomy.aci.businessobjects.AciBusinessObject
com.autonomy.aci.businessobjects.Category
Field Summary | |
static java.lang.String |
DEFAULT_ENCODING
|
static java.lang.String |
DEFAULT_LANGUAGE
|
static int |
DEFAULT_NUM_RESULTS
|
static int |
DEFAULT_THRESHOLD
|
static java.lang.String |
HOME_CATEGORY_ID
|
static java.lang.String |
HOME_CATEGORY_NAME
|
Constructor Summary | |
Category()
|
|
Category(CategoryPath categorylocation)
|
|
Category(java.lang.String sCategoryID)
|
Method Summary | |
void |
addDatabase(java.lang.String sDatabase)
|
void |
addSubCategory(Category subcategory)
Set a category as a sub-category of this one. |
void |
addTrainingDoc(CategoryTrainingDocument doc)
|
void |
clearCatFields()
Deletes all existing category fields and their values. |
void |
clearDatabases()
|
void |
clearSubCategories()
Remove all categories from the list of sub-categories. |
void |
clearTrainingDocs()
|
java.lang.Object |
clone()
|
boolean |
equals(java.lang.Object o)
Indicates whether some other object is "equal to" this category. |
java.lang.String |
getBooleanTraining()
|
java.util.Set |
getCatFieldNames()
|
java.util.HashMap |
getCatFields()
|
java.lang.String |
getCatFieldValue(java.lang.String sFieldname)
|
java.lang.String |
getCatFieldValue(java.lang.String sFieldname,
java.lang.String sDefaultValue)
|
static java.util.Comparator |
getComparator()
|
java.util.ArrayList |
getDatabases()
|
java.lang.String |
getEncoding()
|
TermsNWeights |
getGeneratedTermsAndWeights()
|
java.lang.String |
getLanguage()
|
CategoryPath |
getLocation()
|
TermsNWeights |
getModifiedTermsAndWeights()
|
java.lang.String |
getName()
|
int |
getNumResults()
|
TermsNWeights |
getQueryTermsAndWeights()
|
java.lang.String |
getStatus()
|
java.util.ArrayList |
getSubCategories()
Obtains the list of categories that are contained within this category in the category hierarchy. |
int |
getThreshold()
|
java.util.ArrayList |
getTrainingDocs()
Obtains the list of documents that this category is trained on. |
java.lang.String |
getTrainingText()
|
boolean |
hasSubCategories()
|
void |
removeCatField(java.lang.String sFieldName)
Deletes the category parameter entry for the specified field, if it exists. |
void |
removeSubCategory(Category subcategory)
Remove a category as a sub-category of this one. |
void |
removeTrainingDoc(CategoryTrainingDocument doc)
|
void |
setBooleanTraining(java.lang.String sBooleanTraining)
|
void |
setCatField(java.lang.String sFieldName,
java.lang.String sFieldValue)
Set the value of an category field. |
void |
setCatFields(java.util.Map fieldMap)
Replaces any existing category fields with those provided. |
void |
setDatabases(java.util.ArrayList databaseList)
|
void |
setEncoding(java.lang.String sEncoding)
|
void |
setGeneratedTermsAndWeights(TermsNWeights termsAndWeights)
|
void |
setLanguage(java.lang.String sLanguage)
|
void |
setLocation(CategoryPath categorylocation)
|
void |
setModifiedTermsAndWeights(TermsNWeights termsAndWeights)
|
void |
setName(java.lang.String sName)
|
void |
setNumResults(int nNumResults)
|
void |
setQueryTermsAndWeights(TermsNWeights termsAndWeights)
|
void |
setStatus(java.lang.String sStatus)
|
void |
setSubCategories(java.util.ArrayList subCategoryList)
Specify which categories are contained within this category in the category hierarchy. |
void |
setThreshold(int nThreshold)
|
void |
setTrainingDocs(java.util.List trainingDocsList)
|
void |
setTrainingText(java.lang.String sTrainingText)
|
java.lang.String |
toString()
|
Methods inherited from class com.autonomy.aci.businessobjects.AciBusinessObject |
getUID, setUID |
Methods inherited from class java.lang.Object |
getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String HOME_CATEGORY_ID
public static final java.lang.String HOME_CATEGORY_NAME
public static final java.lang.String DEFAULT_LANGUAGE
public static final java.lang.String DEFAULT_ENCODING
public static final int DEFAULT_THRESHOLD
public static final int DEFAULT_NUM_RESULTS
Constructor Detail |
public Category()
public Category(java.lang.String sCategoryID)
public Category(CategoryPath categorylocation)
Method Detail |
public void setSubCategories(java.util.ArrayList subCategoryList)
subCategoryList
- an ArrayList
of Category
s which are sub-categories of this
category.public void addSubCategory(Category subcategory)
subcategory
- the sub-category to add. This should be a fully populated category preferably as read
in using a LauneService
.public void removeSubCategory(Category subcategory)
subcategory
- the sub-category to remove. This must have at least the category ID set.public void clearSubCategories()
public java.util.ArrayList getSubCategories()
ArrayList
of Category
s.public java.lang.String getName()
public void setName(java.lang.String sName)
public java.lang.String getEncoding()
public void setEncoding(java.lang.String sEncoding)
public java.lang.String getLanguage()
public void setLanguage(java.lang.String sLanguage)
public java.lang.String getStatus()
public void setStatus(java.lang.String sStatus)
public int getThreshold()
public void setThreshold(int nThreshold)
public int getNumResults()
public void setNumResults(int nNumResults)
public java.util.ArrayList getDatabases()
public void clearDatabases()
public void addDatabase(java.lang.String sDatabase)
public void setDatabases(java.util.ArrayList databaseList)
public java.lang.String getTrainingText()
public void setTrainingText(java.lang.String sTrainingText)
public java.lang.String getBooleanTraining()
public void setBooleanTraining(java.lang.String sBooleanTraining)
public TermsNWeights getQueryTermsAndWeights()
public void setQueryTermsAndWeights(TermsNWeights termsAndWeights)
public TermsNWeights getGeneratedTermsAndWeights()
public void setGeneratedTermsAndWeights(TermsNWeights termsAndWeights)
public TermsNWeights getModifiedTermsAndWeights()
public void setModifiedTermsAndWeights(TermsNWeights termsAndWeights)
public void setTrainingDocs(java.util.List trainingDocsList)
public void addTrainingDoc(CategoryTrainingDocument doc)
public void removeTrainingDoc(CategoryTrainingDocument doc)
public void clearTrainingDocs()
public java.util.ArrayList getTrainingDocs()
ArrayList
of Document
s representing the training documents.public void setCatFields(java.util.Map fieldMap)
Map
must be String
s.
fieldMap
- a Map
assosciating String
pairs representing the field names and values.public void setCatField(java.lang.String sFieldName, java.lang.String sFieldValue)
sFieldName
- the name of the category field to set.sFieldValue
- the value to give the field (can be null
).public void removeCatField(java.lang.String sFieldName)
sFieldName
- the name of the field to delete.public void clearCatFields()
public java.util.HashMap getCatFields()
public java.util.Set getCatFieldNames()
public java.lang.String getCatFieldValue(java.lang.String sFieldname, java.lang.String sDefaultValue)
public java.lang.String getCatFieldValue(java.lang.String sFieldname)
public CategoryPath getLocation()
public void setLocation(CategoryPath categorylocation)
public java.lang.Object clone()
public boolean equals(java.lang.Object o)
o
- the reference object with which to compare.
public static java.util.Comparator getComparator()
public java.lang.String toString()
public boolean hasSubCategories()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |