|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Method Summary | |
AciResponse |
buildCategory(Category category,
boolean bBuildChildren)
|
Category |
copyCategory(Category category,
java.lang.String sNewCategoryName,
Category newParentCategory)
|
Category |
createCategory(Category category,
Category parent)
Creates and builds a new category. |
AciResponse |
deleteCategory(Category category)
|
Category |
getCategory(java.lang.String sCatID)
Read the details of a category on the IDOL server and populate a Category object with
this information. |
Category |
getCategoryHierarchy(Category category,
boolean bExpandAll)
Read the category sub-hierarchy headed by a given category. |
ResultList |
getCategoryResults(Category category,
java.util.ArrayList alCategoryGetResultsParams)
Retrieve the documents that currently match a category's training. |
java.util.ArrayList |
getCategorySuggest(java.lang.String queryText,
java.util.ArrayList alSuggestParameters)
Suggest categories in IDOL that are similar to a given query text. |
java.util.ArrayList |
getSimilarCategories(Category category,
java.util.ArrayList alSuggestParameters)
Find categories in IDOL that are similar to a given category. |
AciResponse |
importCategoriesFromXML(java.lang.String sImportFileName,
Category parentCategory)
|
Category |
moveCategory(Category category,
Category newParent)
|
Category |
replaceCategory(Category replacementCategory,
Category originalCategory)
|
Category |
updateCategory(Category category)
Update and build a category. |
Method Detail |
public Category getCategoryHierarchy(Category category, boolean bExpandAll) throws AciException, InvalidCategoryException
Category
objects that make up the hierarchy
only have the category ID and name set - you should call getCategory
to read a
category's full details and training from IDOL.
category
- The category to return hierarchy details for. This can be null
in
which case the hierarchy for the root (0) category is returned.bExpandAll
- whether all sub-categories should be read or just the first level of child categories.
Category
hierarchy starting from the given category or the root (home)
category if this was null.
AciException
- if there was an error when making the request.
InvalidCategoryException
- if the parent categories does not exist.public Category getCategory(java.lang.String sCatID) throws AciException, InvalidCategoryException
Category
object with
this information. The category's basic and hierarchical details, fields, training and terms and weights
are read in during this operation.
sCatID
- the unique ID of the category to read.
Category
as stored on the IDOL server.
AciException
- if there was an error when making the request.
InvalidCategoryException
- if the parent categories does not exist.public Category createCategory(Category category, Category parent) throws AciException, InvalidCategoryException, IDOLException
category
- the details of the category to create. Must have at least a category name set.parent
- the category whose child the new category should be. If null
the new
category is created under the root category.
AciException
- if there was an error when making the request.
InvalidCategoryException
- if the parent categories does not exist.
IDOLException
- if error is return by IDOL server.public AciResponse buildCategory(Category category, boolean bBuildChildren) throws AciException, InvalidCategoryException
AciException
InvalidCategoryException
public Category copyCategory(Category category, java.lang.String sNewCategoryName, Category newParentCategory) throws AciException, InvalidCategoryException
category
- the category to copy. Must have at least a category ID set.sNewCategoryName
- the name to give the new category copy.newParentCategory
- the category whose child the new category should be. If null
the new copy has the same parent as the original category.
AciException
- if there was an error when making the request.
InvalidCategoryException
- if either of the original or new parent categories does not exist.public Category moveCategory(Category category, Category newParent) throws AciException, InvalidCategoryException
AciException
InvalidCategoryException
public Category replaceCategory(Category replacementCategory, Category originalCategory) throws AciException, InvalidCategoryException
AciException
InvalidCategoryException
public AciResponse deleteCategory(Category category) throws AciException, InvalidCategoryException
AciException
InvalidCategoryException
public Category updateCategory(Category category) throws AciException, InvalidCategoryException
getCategory(String)
.
category
- the category to update.
AciException
- if there was an error when making the request.
InvalidCategoryException
- if the category provided does not exist on IDOL.public ResultList getCategoryResults(Category category, java.util.ArrayList alCategoryGetResultsParams) throws AciException, InvalidCategoryException, DataStoreNotFoundException
category
- the category whose results are required.alCategoryGetResultsParams
- extra parameters to send when retrieving category results.
Parameters set here will override any parameters set by the category. Can be null
.
AciException
- if there was an error when making the request.
InvalidCategoryException
- if the category does not exist.
DataStoreNotFoundException
- if the content partition of IDOL was not available.public java.util.ArrayList getCategorySuggest(java.lang.String queryText, java.util.ArrayList alSuggestParameters) throws AciException, InvalidCategoryException
ArrayList
.
queryText
- the String
for which suggected categories should be found.alSuggestParameters
- any additional parameters to be sent with the action. Values
set here will override any that are normally set by this method.
ArrayList
of Category
s which have been found to match the given query text.
AciException
- if there was an error when making the request.
InvalidCategoryException
- if the category does not exist.public AciResponse importCategoriesFromXML(java.lang.String sImportFileName, Category parentCategory) throws AciException, InvalidCategoryException, InvalidImportFileException
AciException
InvalidCategoryException
InvalidImportFileException
public java.util.ArrayList getSimilarCategories(Category category, java.util.ArrayList alSuggestParameters) throws AciException, InvalidCategoryException
ArrayList
.
category
- the Category
for which similar categories should be found.alSuggestParameters
- any additional parameters to be sent with the action. Values
set here will override any that are normally set by this method.
ArrayList
of Category
s which have been found to match the given category.
AciException
- if there was an error when making the request.
InvalidCategoryException
- if the specified category does not exist on IDOL.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |