com.sapportals.wcm.service.indexmanagement.retrieval.classification

Interface IClassificationIndex

All Superinterfaces:

IIndex

public interface IClassificationIndex

extends IIndex

A classification index is a specialized index where document classification and other taxonomy-related operations can be performed.
This interface gives access to these functions.

To get a classification index, follow this example:

  IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE);
  IClassificationIndex classificationIndex = (IClassificationIndex)indexService.getIndex("abc");
 

Note that the index that is requested must support the IClassificationIndex interface. Otherwise a ClassCastException is thrown.

Field Summary

static String	AINBOX_CATEGORY_TO_CLASSIFY Deprecated. as of NW04.
static String	DEFAULT_THRESHOLD_LEVEL1 Default threshold 1 property.
static String	DEFAULT_THRESHOLD_LEVEL2 Default threshold 2 property.
static String	PROP_NAME_BEST_CLASSES_SENSITIVITY Property name of the "BestClassesSensitivity"-property of a taxonomy folder The best classes sensitivity is defined for each taxonomy.
static String	PROP_NAME_THRESHOLD_LEVEL1 Property name of the "threshold 1"-property of a taxonomy folder The taxonomy namespace is used.
static String	PROP_NAME_THRESHOLD_LEVEL2 Property name of the "threshold 2"-property of a taxonomy folder The taxonomy namespace is used.
static String	PROP_NAME_TRAINING_URI Property name of the "training URI"-property of a taxonomy folder The training URI is saved as a property of a taxonomy folder if the taxonomy has been built by copying an existing hierarchy.
static String	TAX_THRESHOLD_DEFAULT_VALUE Default value of the threshold properties if no threshold value is set for a taxonomy.
static String	TAXONOMY_NAMESPACE The namespace suffix of resource properties related to taxonomies and classification To get the complete namespace of a taxonomy property, this suffix has to be appended to the cm namespace.
static String	WORKLIST_FOLDER_NAME Deprecated. as of NW04.

Method Summary

void	addTaxonomy(String taxonomyName) Deprecated. as of NW04. Use addTaxonomy(String,IResourceContext)
void	addTaxonomy(String taxonomyName, IResourceContext context) Adds a new taxonomy to the index By adding the taxonomy name, a folder is created for the taxonomy in the taxonomy repository and the taxonomy is saved with the index.
void	autoClassifyDocs(String taxonomyName, IResourceContext context) Requests proposals for the best categories for documents that have no classification and sets these categories automatically as document classification.
void	autoClassifyDocs(String taxonomyName, IResourceList docList, IResourceContext context) Requests proposals for the best categories for the documents and sets these categories automatically as document classification.
void	autoClassifyDocs(String taxonomyName, IRidList docRidList, IResourceContext context) Requests proposals for the best categories for the documents and sets these categories automatically as document classification.
Collection	classifyDocuments(IResourceList resourceDocuments, String taxonomyName) Classifies documents into existing categories of a taxonomy The returned results are only proposals.
Collection	classifyDocuments(IResourceList resourceDocuments, String taxonomyName, float threshold, int maxResults) Classifies documents into existing categories of a taxonomy The returned results are only proposals.
Collection	classifyDocuments(IResourceList resourceDocuments, String taxonomyName, int maxResults) Classifies documents into existing categories of a taxonomy The returned results are only proposals.
Collection	clusterDocuments(IResourceList resourceDocuments, int maxResults) Divides documents into clusters of documents The clustering is done on the basis of content similarity.
void	createTaxonomyHierarchyByCopiing(String taxonomyName, ICollection existingHierarchy) The taxonomy hierarchy is created by copiing an existing hierarchy.
Map	doGeneric(String function, Map parameters) Enables an index service to perform classification actions that are not reflected by the interface
Collection	getBestClasses(IResourceList resourceDocuments, String taxonomyName)
IResourceList	getClassDocuments(ICollection taxonomyClass) Gets all documents of a taxonomy class The taxonomy class is a folder in the taxonomy repository To get the resource ID of a taxonomy class, first the resource ID of the taxonomy root must be determined by using the getSpecialFolderRID(taxonomyName,SpecialFolder.TAXONOMY) method.
Collection	getClassFeatures(Collection taxonomyClassUris, String taxonomyName, int maxResults) Deprecated. as of NW04. Use getClassFeatures(IRidList taxonomyClassRids,String taxonomyName, int maxResults)
Collection	getClassFeatures(IRidList taxonomyClassRids, String taxonomyName, int maxResults) Gets the features of taxonomy categories The most characteristic key words of a category are returned for each category.
IDocClassificationMap	getDocClassification(IResource document) Gets the categories to which the document is assigned To get proposals of categories that a document might match, use classifyDocuments.
IDocClassificationMapList	getDocListClassification(IResourceList documents) Gets the categories to which the documents are assigned To get proposals of categories into which documents might fit, use classifyDocuments.
Map	getDocumentClassification(IResource document) Deprecated. as of NW04. Use getDocClassification(IResource)
ClassificationStatus	getDocumentClassificationStatus(IResource document, String taxonomyName) Gets the classification status of a document for a taxonomy
IRidList	getDocumentRidsNeverToClassify(String taxonomyName, IResourceContext context) Gets all RIDs of documents for an index that have the status "never to classify" in a taxonomy
IRidList	getDocumentRidsToClassify(String taxonomyName, IResourceContext context) Gets all RIDs of documents of an index that have the status "to classify" in a taxonomy
IResourceList	getDocumentsNeverToClassify(String taxonomyName) Deprecated. as of NW04. Use getDocumentsNeverToClassify(String,IResourceContext)
IResourceList	getDocumentsNeverToClassify(String taxonomyName, IResourceContext context) Gets all documents of an index that have the status "never to classify" in a taxonomy
IResourceList	getDocumentsToClassify(String taxonomyName) Deprecated. as of NW04. Use getDocumentsToClassify(String,IResourceContext)
IResourceList	getDocumentsToClassify(String taxonomyName, IResourceContext context) Gets all documents of an index that have the status "to classify" in a taxonomy
IRidList	getDocumentTrainingClasses(IResource document) Gets all taxonomy classes for which the document is a training document
IRidList	getManuallyDeclassifiedClasses(IResource document)
IClassificationIndexCollection	getNewClassificationIndexCollection() Returns an index collection where classification operations for multiple indexes can be performed
RID	getSpecialFolderRID(String taxonomyName, SpecialFolder specialFolderType)
List	getTaxonomies() Names of all taxonomies of an index The name of a taxonomy is also the name of the taxonomy folder in the taxonomy repository.
BestClassesSensitivity	getTaxonomyBestClassesSensitivity(String taxonomyName) Gets the sensitivity level of the best classes algorithm
float	getTaxonomyClassificationThreshold(String taxonomyName, String thresholdId) Gets the threshold of a taxonomy
String	getTaxonomyRmPrefix()
Runnable	getTaxonomyTrainingCrawler(ICollection taxonomyCollection, boolean isSearchRelevant) Deprecated. as of NW04. Use startTaxonomyTrainingCrawler
RID	getTaxonomyTrainingRid(String taxonomyName) Gets the URI of the root folder of the hierarchy that has been used to train/create the given taxonomy.
URI	getTaxonomyTrainingUri(String taxonomyName) Deprecated. as of NW04. Use getTaxonomyTrainingRid(String)
TaxonomyType	getTaxonomyType(String taxonomyName)
UpdateTaxonomyState	getUpdateTaxonomyState(String taxonomyName) Returns the actual state of the taxonomy with respect to an actually running update.
UpdateTaxonomyState	getUpdateTaxonomyState(String taxonomyName, Locale locale) Returns the actual state of the taxonomy with respect to an actually running update.
boolean	hasTaxonomy(String name)
void	indexDocument(IResource resource, String taxonomyName, IRidList taxonomyClasses, boolean isSearchRelevant) Puts a document into the index It is recommended that you do not index a document manually using this method.
void	indexDocument(IResource resource, String taxonomyName, IUriList taxonomyClasses, boolean isSearchRelevant) Deprecated. as of NW04. Use indexDocument(IResource, String, IRidList, boolean)
void	indexDocuments(IResourceList resources, String taxonomyName, IRidList taxonomyClasses, boolean isSearchRelevant) Indexes a list of documents It is recommended that you do not index documents manually using this method.
void	indexDocuments(IResourceList resources, String taxonomyName, IUriList taxonomyClasses, boolean isSearchRelevant) Deprecated. as of NW04. Use indexDocuments(IResourceList, String, IRidList, boolean)
void	initTaxonomies(List taxonomies) Sets the index taxonomies initially before generating the index After the index has been created, the taxonomy folders are created automatically.
boolean	isTrainingDocument(IResource document, RID taxonomyClassRid)
void	queueTaxonomyTrainingCrawler(ICollection taxonomyCollection, boolean isSearchRelevant) Deprecated. as of NW04. Use queueTaxonomyTrainingCrawler(String,ICollection,boolean)
void	queueTaxonomyTrainingCrawler(String taxonomyName, ICollection taxonomyCollection, boolean isSearchRelevant) Adds a taxonomy training crawler to the index management crawler queue.
void	removeCategoryAssignments(ICollection deletedCategoryFolder) Removes the assignment to a deleted category for all documents in the index
void	removeTaxonomy(String taxonomyName) Deprecated. as of NW04. Use removeTaxonomy(String,IResourceContext)
void	removeTaxonomy(String taxonomyName, IResourceContext context) Removes a taxonomy form the index By removing a taxonomy, the folder for the taxonomy in the taxonomy repository is deleted and the taxonomy itself is removed from the index.
void	setDocClassification(IDocClassificationMap documentClassificationMap) Stores the document classification that has been chosen by manual or automatic classification
void	setDocClassification(IDocClassificationMap documentClassificationMap, boolean indexDocumentClassification) Stores the document classification that has been chosen by manual or automatic classification
void	setDocClassification(IDocClassificationMap documentClassificationMap, boolean indexDocumentClassification, boolean isTrainingDocument) Stores the document classification that has been chosen by manual or automatic classification
void	setDocClassification(IDocClassificationMap documentClassificationMap, String notToSend)
void	setDocListClassification(IDocClassificationMapList documentClassificationMapList) Stores the documents classification that has been chosen by manual or automatic classification
void	setDocumentClassification(IResource document, Map classification) Deprecated. as of NW04. Use setDocClassification(IResource,Map)
void	setDocumentClassification(IResource document, Map classification, boolean indexDocumentClassification) Deprecated. as of NW04. Use setDocClassification(IResource,Map,boolean)
void	setDocumentClassification(IResource document, Map classification, boolean indexDocumentClassification, boolean isTrainingDocument) Deprecated. as of NW04. Use setDocClassification(IResource,Map,boolean, boolean)
void	setDocumentClassificationStatus(IResourceList documents, String taxonomyName, ClassificationStatus status) Sets the classification status for a list of documents for a taxonomy
void	setDocumentClassificationStatus(IResource document, String taxonomyName, ClassificationStatus status) Sets the classification status of a document for a taxonomy
void	setDocumentClassificationStatus(IResource document, String taxonomyName, ClassificationStatus status, boolean sendEvents, String notToSend) This method is for internal usage only
void	setDocumentClassificationStatus(IResource document, String taxonomyName, ClassificationStatus status, String notToSend) This method is for internal usage only
void	setTaxonomyBestClassesSensitivity(String taxonomyName, BestClassesSensitivity sensitivity) Sets the threshold of a taxonomy
void	setTaxonomyClassificationThreshold(String taxonomyName, String thresholdId, float threshold) Sets the threshold of a taxonomy
void	setTaxonomyTrainingRid(String taxonomyName, RID trainingRid) Sets the RID of the root folder of the hierarchy that has been used to train/create the given taxonomy.
void	setTaxonomyTrainingUri(String taxonomyName, URI trainingUri) Deprecated. as of NW04. Use setTaxonomyTrainingRid(String, RID)
void	setTaxonomyType(String taxonomyName, TaxonomyType taxonomyType)
void	startTaxonomyTrainingCrawler(ICollection taxonomyCollection, boolean isSearchRelevant) Deprecated. as of NW04. Crawlers can only be queued - use queueTaxonomyTrainingCrawler(String,ICollection,boolean)
void	startTaxonomyTrainingCrawler(ICollection taxonomyCollection, boolean isSearchRelevant, boolean clearVisitedList, ISemaphore semaphore) Deprecated. as of NW04. Use startTaxonomyTrainingCrawler(String,ICollection,boolean,boolean,ISemaphore)
void	startTaxonomyTrainingCrawler(String taxonomyName, ICollection taxonomyCollection, boolean isSearchRelevant, boolean clearVisitedList, ISemaphore semaphore) Runs a taxonomy training crawler.
void	synchronizeTaxonomyMetaData(String taxonomyName) Rebuilds the taxonomy meta data on the classification engine.
void	updateSearchCategoryAttributes(IResourceList oldResourceListe, IResourceList newResourceListe, String taxonomyName, RID categoryRid) The attributes neccessary for searching in taxonomies are modified on the index server only.
boolean	useBestClasses()

Methods inherited from interface com.sapportals.wcm.service.indexmanagement.IIndex

addFolderUri, checkProperties, clear, createIndexOnServer, deindexDocument, deindexDocument, deindexDocument, deindexDocuments, deindexDocuments, deindexDocuments, delete, delete, deleteOnServer, deltaReindex, generate, generate, getCrawlerProfileId, getFolderUris, getIndexedProperties, getIndexFolderForDocument, getIndexFolders, getIndexGroup, getIndexId, getIndexingState, getIndexName, getLanguagesOfIndexedDocuments, getProperties, getResourceInfo, getRID, getSchedulerTimeTable, getServiceId, getServiceTypes, getServiceTypes, getSupportedOptions, getWhatToIndexString, indexDocument, indexDocument, indexDocuments, indexDocuments, indexInternalLinks, init, isActive, reduceNumberOfCrawler, reindex, reindex, removeAllFolderUris, removeFolderUri, setActive, setActiveDuringStartup, setCrawlerProfileId, setInactiveIndexHasChanged, setIndexGroup, setIndexingState, setIndexName, setProperties, setSchedulerTimeTable, setStateAndNumberOfCrawler, setWhatToIndex, typeShouldBeIndexed

Field Detail

TAXONOMY_NAMESPACE

public static final String TAXONOMY_NAMESPACE

The namespace suffix of resource properties related to taxonomies and classification To get the complete namespace of a taxonomy property, this suffix has to be appended to the cm namespace.

Example:

  String namespace = new StringBuffer(IWcmConst.SAP_WCM_NAMESPACE).append(IClassificationIndex.TAXONOMY_NAMESPACE).toString();
 

See Also:

Constant Field Values

PROP_NAME_THRESHOLD_LEVEL1

public static final String PROP_NAME_THRESHOLD_LEVEL1

Property name of the "threshold 1"-property of a taxonomy folder
The taxonomy namespace is used.
It is recommended that you do not access the value directly from the property. getTaxonomyClassificationThreshold should be used instead.

See Also:

TAXONOMY_NAMESPACE, getTaxonomyClassificationThreshold(String,String), Constant Field Values

PROP_NAME_THRESHOLD_LEVEL2

public static final String PROP_NAME_THRESHOLD_LEVEL2

Property name of the "threshold 2"-property of a taxonomy folder
The taxonomy namespace is used.
It is recommended that you do not access the value directly from the property. getTaxonomyClassificationThreshold should be used instead.

See Also:

TAXONOMY_NAMESPACE, getTaxonomyClassificationThreshold(String,String), Constant Field Values

PROP_NAME_BEST_CLASSES_SENSITIVITY

public static final String PROP_NAME_BEST_CLASSES_SENSITIVITY

Property name of the "BestClassesSensitivity"-property of a taxonomy folder
The best classes sensitivity is defined for each taxonomy. It defines the sensitivity of the "best classes"-algorithm that selects the best categories from the proposed categories and assigns them to a document.
The taxonomy namespace is used.
It is recommended that you do not access the value directly from the property. getTaxonomyBestClassesSensitivity should be used instead.

See Also:

TAXONOMY_NAMESPACE, getTaxonomyBestClassesSensitivity(String), Constant Field Values

PROP_NAME_TRAINING_URI

public static final String PROP_NAME_TRAINING_URI

Property name of the "training URI"-property of a taxonomy folder
The training URI is saved as a property of a taxonomy folder if the taxonomy has been built by copying an existing hierarchy.
The taxonomy namespace is used.
It is recommended that you do not access the value directly from the property. getTaxonomyTrainingRid should be used instead.

See Also:

TAXONOMY_NAMESPACE, getTaxonomyTrainingRid(String), Constant Field Values

DEFAULT_THRESHOLD_LEVEL1

public static final String DEFAULT_THRESHOLD_LEVEL1

Default threshold 1 property. It is defined in the taxonomy manager configuration.

See Also:

Constant Field Values

DEFAULT_THRESHOLD_LEVEL2

public static final String DEFAULT_THRESHOLD_LEVEL2

Default threshold 2 property. It is defined in the taxonomy manager configuration.

See Also:

Constant Field Values

TAX_THRESHOLD_DEFAULT_VALUE

public static final String TAX_THRESHOLD_DEFAULT_VALUE

Default value of the threshold properties if no threshold value is set for a taxonomy.

See Also:

Constant Field Values

WORKLIST_FOLDER_NAME

public static final String WORKLIST_FOLDER_NAME

Deprecated. as of NW04.

The name of the virtual folder that contains the taxonomy hierarchy with links of documents that could not be classified so far

See Also:

Constant Field Values

AINBOX_CATEGORY_TO_CLASSIFY

public static final String AINBOX_CATEGORY_TO_CLASSIFY

Deprecated. as of NW04.

Action inbox category "to classify"

See Also:

Constant Field Values

Method Detail

getTaxonomies

public List getTaxonomies()

Names of all taxonomies of an index
The name of a taxonomy is also the name of the taxonomy folder in the taxonomy repository.

Returns:

list of the taxonomy names (String) of the classification index

addTaxonomy

public void addTaxonomy(String taxonomyName)
                 throws WcmException

Deprecated. as of NW04. Use addTaxonomy(String,IResourceContext)

Adds a taxonomy to the index

Parameters:

taxonomyName - name of the taxonomy to be added to the index

Throws:

WcmException - exception raised in failure situation

addTaxonomy

public void addTaxonomy(String taxonomyName,
                        IResourceContext context)
                 throws WcmException

Adds a new taxonomy to the index
By adding the taxonomy name, a folder is created for the taxonomy in the taxonomy repository and the taxonomy is saved with the index.

Parameters:

taxonomyName - name of the taxonomy to be added to the index

context - user context

Throws:

WcmException - exception raised in failure situation

removeTaxonomy

public void removeTaxonomy(String taxonomyName)

Deprecated. as of NW04. Use removeTaxonomy(String,IResourceContext)

Removes a taxonomy from the index

Parameters:

taxonomyName - name of the taxonomy to remove

removeTaxonomy

public void removeTaxonomy(String taxonomyName,
                           IResourceContext context)
                    throws WcmException

Removes a taxonomy form the index
By removing a taxonomy, the folder for the taxonomy in the taxonomy repository is deleted and the taxonomy itself is removed from the index.

Parameters:

taxonomyName - name of the taxonomy to remove

context - user context

Throws:

WcmException

indexDocument

public void indexDocument(IResource resource,
                          String taxonomyName,
                          IUriList taxonomyClasses,
                          boolean isSearchRelevant)
                   throws ResourceException,
                          WcmException,
                          IOException

Deprecated. as of NW04. Use indexDocument(IResource, String, IRidList, boolean)

Indexes a document

Throws:

ResourceException

WcmException

IOException

indexDocument

public void indexDocument(IResource resource,
                          String taxonomyName,
                          IRidList taxonomyClasses,
                          boolean isSearchRelevant)
                   throws ResourceException,
                          WcmException,
                          IOException

Puts a document into the index
It is recommended that you do not index a document manually using this method.
For repositories that send cm events, documents are indexed automatically when their content or their properties are changed.
For repositories that do not support eventing, for example, Web repositories, a delta index crawler should be scheduled for the index folders that need to be updated.

Parameters:

resource - resource to index

taxonomyName - name of the taxonomy where the taxonomy classes have to be indexed with the document

taxonomyClasses - taxonomy classes to index with the document

isSearchRelevant - if true, the document can be found in a search if false the document is only for training the taxonomy classes

Throws:

ResourceException - exception raised in failure situation

WcmException - exception raised in failure situation

IOException - exception raised in failure situation

indexDocuments

public void indexDocuments(IResourceList resources,
                           String taxonomyName,
                           IUriList taxonomyClasses,
                           boolean isSearchRelevant)
                    throws ResourceException,
                           WcmException,
                           IOException

Deprecated. as of NW04. Use indexDocuments(IResourceList, String, IRidList, boolean)

Indexes a list of documents

Throws:

ResourceException

WcmException

IOException

indexDocuments

public void indexDocuments(IResourceList resources,
                           String taxonomyName,
                           IRidList taxonomyClasses,
                           boolean isSearchRelevant)
                    throws ResourceException,
                           WcmException,
                           IOException

Indexes a list of documents It is recommended that you do not index documents manually using this method.
For repositories that send cm events, documents are indexed automatically when their content or their properties are changed.
For repositories that do not support eventing, for example, Web repositories, a delta index crawler should be scheduled for the index folders that need to be updated.

Parameters:

resources - resources to index

taxonomyName - name of the taxonomy where the taxonomy classes have to be indexed with the document

taxonomyClasses - taxonomy classes to index with the documents

isSearchRelevant - if true, the documents can be found in a search; if false the document is only for training the taxonomy classes

Throws:

ResourceException - exception raised in failure situation

WcmException - exception raised in failure situation

IOException - exception raised in failure situation

getClassFeatures

public Collection getClassFeatures(Collection taxonomyClassUris,
                                   String taxonomyName,
                                   int maxResults)
                            throws WcmException

Deprecated. as of NW04. Use getClassFeatures(IRidList taxonomyClassRids,String taxonomyName, int maxResults)

Gets the features of taxonomy categories

Parameters:

taxonomyClassUris - collection of URI that represent taxonomy class folders

taxonomyName - name of the taxonomy you want to have class features for

maxResults - maximum number of class features returned

Returns:

collection of IClassificationResult

Throws:

WcmException - exception raised in failure situation

getClassFeatures

public Collection getClassFeatures(IRidList taxonomyClassRids,
                                   String taxonomyName,
                                   int maxResults)
                            throws WcmException

Gets the features of taxonomy categories
The most characteristic key words of a category are returned for each category. They are contained in the documents that are assigned to a category.

Example:

  IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE);
  IClassificationIndex classificationIndex = (IClassificationIndex)indexService.getIndex("abc");
  IRidList categoryRids = new RidList();
  categoryRids.add(RID.getRID("/taxonomies/abc/taxonomyXY/catXY"));
  Collection classificationResults = classificationIndex.getClassFeatures(categoryRids,"taxonomyXY",5);
  IClassificationResult classificationResult = (IClassificationResult)classificationResults.get(0);
  Collection featuresList = classificationResult.getResults();
  Iterator featureIterator = featuresList.iterator();
  String feature = null;
  while(featureIterator.hasNext()){
    feature = (String)featureIterator.next();
  }
 

Parameters:

taxonomyClassRids - list of RIDs that represent taxonomy class folders

taxonomyName - name of the taxonomy you want to have class features for

maxResults - maximum number of class features returned

Returns:

collection of IClassificationResult

Throws:

WcmException - exception raised in failure situation

See Also:

IClassificationResult

classifyDocuments

public Collection classifyDocuments(IResourceList resourceDocuments,
                                    String taxonomyName,
                                    int maxResults)
                             throws WcmException

Classifies documents into existing categories of a taxonomy
The returned results are only proposals. To assign documents to categories, use setDocClassification. To get the categories that have been assigned to a document, use getDocClassification.

Example:

  IResource document = ResourceFactory.getInstance().getResource(RID.getRID("/documents/abc.doc"),context);
  IResourceList documents = new ResourceList();
  documents.add(document);
  IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE);
  IClassificationIndex classificationIndex = (IClassificationIndex)indexService.getIndex("abc");
  Collection classificationResults = classificationIndex.classifyDocuments(documents,"taxonomyXY",5);
  IClassificationResult classificationResult = (IClassificationResult)classificationResults.get(0);
  Collection resultClasses = classificationResult.getResults();
  Iterator resultClassesIterator = resultClasses.iterator();
  IClassificationClass resultClass = null;
  RID resultClassRID = null;
  float rankValue = 0.0F;
  while(resultClassesIterator.hasNext()){
    resultClass = (IClassificationClass)resultClassesIterator.next();
    resultClassRID = resultClass.getResultClassRid();
    rankValue = resultClass.getRankValue();
  }
 

Parameters:

resourceDocuments - list of documents you want to classify

taxonomyName - name of the taxonomy for which classification proposals have to be found

maxResults - maximum number of returned proposals for each document

Returns:

collection of IClassificationResult

Throws:

WcmException - exception raised in failure situation

See Also:

IClassificationResult, getDocClassification(IResource), setDocClassification(IDocClassificationMap)

classifyDocuments

public Collection classifyDocuments(IResourceList resourceDocuments,
                                    String taxonomyName)
                             throws WcmException

Classifies documents into existing categories of a taxonomy
The returned results are only proposals. To assign documents to categories, use setDocClassification. To get the categories that have been assigned to a document, use getDocClassification.

Example:

  IResource document = ResourceFactory.getInstance().getResource(RID.getRID("/documents/abc.doc"),context);
  IResourceList documents = new ResourceList();
  documents.add(document);
  IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE);
  IClassificationIndex classificationIndex = (IClassificationIndex)indexService.getIndex("abc");
  Collection classificationResults = classificationIndex.classifyDocuments(documents,"taxonomyXY");
  IClassificationResult classificationResult = (IClassificationResult)classificationResults.get(0);
  Collection resultClasses = classificationResult.getResults();
  Iterator resultClassesIterator = resultClasses.iterator();
  IClassificationClass resultClass = null;
  RID resultClassRID = null;
  float rankValue = 0.0F;
  while(resultClassesIterator.hasNext()){
    resultClass = (IClassificationClass)resultClassesIterator.next();
    resultClassRID = resultClass.getResultClassRid();
    rankValue = resultClass.getRankValue();
  }
 

Parameters:

resourceDocuments - list of documents you want to classify

taxonomyName - name of the taxonomy for which classification proposals have to be found

Returns:

collection of IClassificationResult

Throws:

WcmException - exception raised in failure situation

See Also:

IClassificationResult, getDocClassification(IResource), setDocClassification(IDocClassificationMap)

classifyDocuments

public Collection classifyDocuments(IResourceList resourceDocuments,
                                    String taxonomyName,
                                    float threshold,
                                    int maxResults)
                             throws WcmException

Classifies documents into existing categories of a taxonomy
The returned results are only proposals. To assign documents to categories, use setDocClassification. To get the categories that have been assigned to a document, use getDocClassification.

Example:

  IResource document = ResourceFactory.getInstance().getResource(RID.getRID("/documents/abc.doc"),context);
  IResourceList documents = new ResourceList();
  documents.add(document);
  IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE);
  IClassificationIndex classificationIndex = (IClassificationIndex)indexService.getIndex("abc");
  //returns a maximum of 5 classes for each document that have rank values higher than 0.7
  Collection classificationResults = classificationIndex.classifyDocuments(documents,"taxonomyXY",0.7F,5);
  IClassificationResult classificationResult = (IClassificationResult)classificationResults.get(0);
  Collection resultClasses = classificationResult.getResults();
  Iterator resultClassesIterator = resultClasses.iterator();
  IClassificationClass resultClass = null;
  RID resultClassRID = null;
  float rankValue = 0.0F;
  while(resultClassesIterator.hasNext()){
    resultClass = (IClassificationClass)resultClassesIterator.next();
    resultClassRID = resultClass.getResultClassRid();
    rankValue = resultClass.getRankValue();
  }
 

Parameters:

resourceDocuments - resource list of documents you want to classify

taxonomyName - name of the taxonomy for which classification proposals have to be found

threshold - lowest rank value of a returned taxonomy class

maxResults - maximum number of proposals returned for each document

Returns:

collection of IClassificationResult

Throws:

WcmException - exception raised in failure situation

See Also:

IClassificationResult, getDocClassification(IResource), setDocClassification(IDocClassificationMap)

clusterDocuments

public Collection clusterDocuments(IResourceList resourceDocuments,
                                   int maxResults)
                            throws WcmException

Divides documents into clusters of documents
The clustering is done on the basis of content similarity.

Note: This method is not yet supported by the implementing classes.

Parameters:

resourceDocuments - list of documents you want to cluster

maxResults - maximum number of returned clusters

Returns:

collection of clusters (ICluster)

Throws:

WcmException - exception raised in failure situation

See Also:

ICluster

getNewClassificationIndexCollection

public IClassificationIndexCollection getNewClassificationIndexCollection()
                                                                   throws ResourceException

Returns an index collection where classification operations for multiple indexes can be performed

Returns:

classification index collection

Throws:

ResourceException - exception raised in failure situation

getClassDocuments

public IResourceList getClassDocuments(ICollection taxonomyClass)
                                throws WcmException,
                                       ResourceException

Gets all documents of a taxonomy class
The taxonomy class is a folder in the taxonomy repository To get the resource ID of a taxonomy class, first the resource ID of the taxonomy root must be determined by using the getSpecialFolderRID(taxonomyName,SpecialFolder.TAXONOMY) method. Then the path from the taxonomy root to the category must be appended to this resource ID.

Example:

  RID taxonomyRid = classificationIndex.getSpecialFolderRID("taxonomyXY",SpecialFolder.TAXONOMY);
  RID categoryRid = taxonomyRid.add(RID.getRID("/categoryXY"));
 

Result: "/taxonomies/indexXY/taxonomyXY/categoryXY"
Now the collection can be requested from the resource factory:

  ICollection category = (ICollection)ResourceFactory.getInstance().getResource(categoryRid,context);
 

Parameters:

taxonomyClass - taxonomy class folder you want to have documents for

Returns:

list of documents that are assigned to the taxonomy class (category)

Throws:

WcmException - exception raised in failure situation

ResourceException - exception raised in failure situation

See Also:

getSpecialFolderRID(String,SpecialFolder)

initTaxonomies

public void initTaxonomies(List taxonomies)

Sets the index taxonomies initially before generating the index
After the index has been created, the taxonomy folders are created automatically.

Parameters:

taxonomies - list of taxonomy names (String)

doGeneric

public Map doGeneric(String function,
                     Map parameters)
              throws WcmException

Enables an index service to perform classification actions that are not reflected by the interface

Parameters:

function - name of the function that has to be performed

parameters - parameters for the function that has to be performed

Returns:

map with results of the executed function

Throws:

WcmException - exception raised in failure situation

getDocumentClassification

public Map getDocumentClassification(IResource document)
                              throws WcmException

Deprecated. as of NW04. Use getDocClassification(IResource)

Gets the classification that has been set for the document
This call has nothing to do with classifying documents. It only gives the document classes set by setDocumentClassification().

Parameters:

document - document for which the classification has to be returned

Returns:

map with document classification Key is (String) taxonomy name. Value is IRidList of taxonomy class rids.

Throws:

WcmException - exception raised in failure situation

getDocClassification

public IDocClassificationMap getDocClassification(IResource document)
                                           throws WcmException

Gets the categories to which the document is assigned
To get proposals of categories that a document might match, use classifyDocuments.

Example:

  IDocClassificationMap docClassification = classificationIndex.getDocClassification(document);
  String taxonomyName = "taxonomyXY";
  IRidList taxonomyCategories = docClassification.getClasses(taxonomyName);
 

The example returns a list of resource IDs for category folders in the taxonomy repository to which the document is assigned as regards taxonomy "taxonomyXY".

Parameters:

document - document for which the classification has to be returned

Returns:

IDocClassificationMap with classifications for each taxonomy name

Throws:

WcmException - exception raised in failure situation

getDocListClassification

public IDocClassificationMapList getDocListClassification(IResourceList documents)
                                                   throws WcmException

Gets the categories to which the documents are assigned
To get proposals of categories into which documents might fit, use classifyDocuments.

Example:

  IDocClassificationMapList docClassificationList = classificationIndex.getDocListClassification(documents);
  IDocClassificationMap docClassification = docClassificationList.get(0);
  String taxonomyName = "taxonomyXY";
  IRidList taxonomyCategories = docClassification.getClasses(taxonomyName);
 

The example returns a list of resource IDs for category folders in the taxonomy repository to which the first document in the list is assigned as regards taxonomy "taxonomyXY".

Parameters:

documents - list of documents for which the classification has to be returned

Returns:

IDocClassificationMapList that contains an IDocClassificationMap for every document

Throws:

WcmException - exception raised in failure situation

setDocClassification

public void setDocClassification(IDocClassificationMap documentClassificationMap)
                          throws WcmException

Stores the document classification that has been chosen by manual or automatic classification

Parameters:

documentClassificationMap - container with the document and its classification for all taxonomies

Throws:

WcmException - exception raised in failure situation

setDocClassification

public void setDocClassification(IDocClassificationMap documentClassificationMap,
                                 String notToSend)
                          throws WcmException

Throws:

WcmException

setDocClassification

public void setDocClassification(IDocClassificationMap documentClassificationMap,
                                 boolean indexDocumentClassification)
                          throws WcmException

Stores the document classification that has been chosen by manual or automatic classification

Parameters:

documentClassificationMap - container with the document and its classification for all taxonomies

indexDocumentClassification - if true, the document classification is indexed. If false, the document classification is only stored as an application property with the document and is not indexed. Warning: Should only be "false" if the document is indexed immediately before or after the call by another routine.

Throws:

WcmException - exception raised in failure situation

setDocClassification

public void setDocClassification(IDocClassificationMap documentClassificationMap,
                                 boolean indexDocumentClassification,
                                 boolean isTrainingDocument)
                          throws WcmException

Stores the document classification that has been chosen by manual or automatic classification

Parameters:

documentClassificationMap - container with the document and its classification for all taxonomies

indexDocumentClassification - if true, the document classification is indexed. If false, the document classification is only stored as an application property with the document and is not indexed. Warning: Should only be "false" if the document is indexed immediately before or after the call by another routine.

isTrainingDocument - if true, the classification is indexed to train the index

Throws:

WcmException - exception raised in failure situation

setDocListClassification

public void setDocListClassification(IDocClassificationMapList documentClassificationMapList)
                              throws WcmException

Stores the documents classification that has been chosen by manual or automatic classification

Parameters:

documentClassificationMapList - list of containers with the document and its classification for all taxonomies

Throws:

WcmException - exception raised in failure situation

setDocumentClassification

public void setDocumentClassification(IResource document,
                                      Map classification)
                               throws WcmException

Deprecated. as of NW04. Use setDocClassification(IResource,Map)

Stores the document classification that has been chosen by manual or automatic classification

Parameters:

document - document for which the classification has to be set

classification - map with document classification. Key is (String) taxonomy name. Value is IRidList of taxonomy class RIDs.

Throws:

WcmException - exception raised in failure situation

setDocumentClassification

public void setDocumentClassification(IResource document,
                                      Map classification,
                                      boolean indexDocumentClassification)
                               throws WcmException

Deprecated. as of NW04. Use setDocClassification(IResource,Map,boolean)

Stores the document classification that has been chosen by manual or automatic classification

Parameters:

document - document for which the classification has to be set

classification - map with document classification. Key is (String) taxonomy name. Value is IRidList of taxonomy class RIDs.

indexDocumentClassification - if true, the document classification is indexed. If false, the document classification is only stored as an application property with the document and is not indexed. Warning: Should only be "false" if the document is indexed immediately before or after the call by another routine.

Throws:

WcmException - exception raised in failure situation

setDocumentClassification

public void setDocumentClassification(IResource document,
                                      Map classification,
                                      boolean indexDocumentClassification,
                                      boolean isTrainingDocument)
                               throws WcmException

Deprecated. as of NW04. Use setDocClassification(IResource,Map,boolean, boolean)

Stores the document classification that has been chosen by manual or automatic classification

Parameters:

document - document for which the classification has to be set

classification - map with document classification. Key is (String) taxonomy name. Value is IRidList of taxonomy class RIDs.

indexDocumentClassification - if true, the document classification is indexed. If false, the document classification is only stored as an application property with the document and is not indexed. Warning: Should only be "false" if document is indexed immediately before or after the call by another routine.

isTrainingDocument - if true, the classification is indexed to train the index

Throws:

WcmException - exception raised in failure situation

getTaxonomyTrainingCrawler

public Runnable getTaxonomyTrainingCrawler(ICollection taxonomyCollection,
                                           boolean isSearchRelevant)
                                    throws WcmException

Deprecated. as of NW04. Use startTaxonomyTrainingCrawler

Returns a crawler that runs as a thread

Parameters:

isSearchRelevant - indicates whether the documents are to become part of the index or should only be used to train the index

taxonomyCollection - start collection of the hierarchy that is used to build up the taxonomy

Returns:

crawler as a runnable object

- Example:

Runnable taxonomyTrainingCrawler = clIndex.getTaxonomyTrainingCrawler(taxonomyCollection,false); Thread crawlerThread = new Thread(taxonomyTrainingCrawler);

crawlerThread.start();

Throws:

WcmException - exception raised in failure situation

startTaxonomyTrainingCrawler

public void startTaxonomyTrainingCrawler(ICollection taxonomyCollection,
                                         boolean isSearchRelevant)
                                  throws WcmException

Deprecated. as of NW04. Crawlers can only be queued - use queueTaxonomyTrainingCrawler(String,ICollection,boolean)

Runs a taxonomy training crawler

Parameters:

taxonomyCollection - start collection of the hierarchy that is used to build up the taxonomy

isSearchRelevant - indicates whether the documents are to become part of the index or should only be used to train the index

Throws:

WcmException - exception raised in failure situation

startTaxonomyTrainingCrawler

public void startTaxonomyTrainingCrawler(ICollection taxonomyCollection,
                                         boolean isSearchRelevant,
                                         boolean clearVisitedList,
                                         ISemaphore semaphore)
                                  throws WcmException

Deprecated. as of NW04. Use startTaxonomyTrainingCrawler(String,ICollection,boolean,boolean,ISemaphore)

Runs a taxonomy training crawler.

Parameters:

taxonomyCollection - start collection of the hierarchy that is used to build up the taxonomy

isSearchRelevant - indicates whether the documents are to become part of the index or should only be used to train the index

clearVisitedList - clears all entries from the visited list of the index before crawling

semaphore - is acquired in the constructor of the training crawler and is blocked as long as the crawler is running The initial state must be unacquired. Other objects that acquire the semaphore must wait until the training crawler releases the semaphore.

Throws:

WcmException - exception raised in failure situation semaphore can be null

startTaxonomyTrainingCrawler

public void startTaxonomyTrainingCrawler(String taxonomyName,
                                         ICollection taxonomyCollection,
                                         boolean isSearchRelevant,
                                         boolean clearVisitedList,
                                         ISemaphore semaphore)
                                  throws WcmException

Runs a taxonomy training crawler.

Parameters:

taxonomyName - name of the taxonomy

taxonomyCollection - start collection of the hierarchy that is used to build up the taxonomy

isSearchRelevant - indicates whether the documents are to become part of the index or should only be used to train the index

clearVisitedList - clears all entries from the visited list of the index before crawling

semaphore - is acquired in the constructor of the training crawler and is blocked as long as the crawler is running The initial state must be unacquired. Other objects that acquire the semaphore must wait until the training crawler releases the semaphore.

Throws:

WcmException - exception raised in failure situation semaphore can be null

queueTaxonomyTrainingCrawler

public void queueTaxonomyTrainingCrawler(ICollection taxonomyCollection,
                                         boolean isSearchRelevant)
                                  throws WcmException

Deprecated. as of NW04. Use queueTaxonomyTrainingCrawler(String,ICollection,boolean)

Adds a taxonomy training crawler to the index management crawler queue

Parameters:

isSearchRelevant - indicates whether the documents are to become part of the index or should only be used to train the index

taxonomyCollection - start collection of the hierarchy that is used to build up the taxonomy

Throws:

WcmException - exception raised in failure situation

queueTaxonomyTrainingCrawler

public void queueTaxonomyTrainingCrawler(String taxonomyName,
                                         ICollection taxonomyCollection,
                                         boolean isSearchRelevant)
                                  throws WcmException

Adds a taxonomy training crawler to the index management crawler queue.

Parameters:

taxonomyName - name of the taxonomy

taxonomyCollection - start collection of the hierarchy that is used to build up the taxonomy

isSearchRelevant - indicates whether the documents are to become part of the index or should only be used to train the index

Throws:

WcmException - exception raised in failure situation

createTaxonomyHierarchyByCopiing

public void createTaxonomyHierarchyByCopiing(String taxonomyName,
                                             ICollection existingHierarchy)
                                      throws WcmException

The taxonomy hierarchy is created by copiing an existing hierarchy.

Parameters:

taxonomyName - name of the taxonomy

existingHierarchy - root folder of the hierarchy to copy

Throws:

WcmException

getTaxonomyClassificationThreshold

public float getTaxonomyClassificationThreshold(String taxonomyName,
                                                String thresholdId)
                                         throws WcmException

Gets the threshold of a taxonomy

Parameters:

taxonomyName - name of the taxonomy (must exist for index)

thresholdId - Constant IClassificationIndex.PROP_NAME_THRESHOLD_LEVEL1 or IClassificationIndex.PROP_NAME_THRESHOLD_LEVEL2

Returns:

the requested threshold value for the specified taxonomy

Throws:

WcmException - exception raised in failure situation

setTaxonomyClassificationThreshold

public void setTaxonomyClassificationThreshold(String taxonomyName,
                                               String thresholdId,
                                               float threshold)
                                        throws WcmException

Sets the threshold of a taxonomy

Parameters:

taxonomyName - name of the taxonomy (must exist for index)

thresholdId - Constant IClassificationIndex.PROP_NAME_THRESHOLD_LEVEL1 or IClassificationIndex.PROP_NAME_THRESHOLD_LEVEL2

threshold - the threshold value for the specified taxonomy that has to be set

Throws:

WcmException - exception raised in failure situation

getTaxonomyTrainingUri

public URI getTaxonomyTrainingUri(String taxonomyName)
                           throws WcmException

Deprecated. as of NW04. Use getTaxonomyTrainingRid(String)

Throws:

WcmException

getTaxonomyTrainingRid

public RID getTaxonomyTrainingRid(String taxonomyName)
                           throws WcmException

Gets the URI of the root folder of the hierarchy that has been used to train/create the given taxonomy. The information about the location of the training URI is needed when reindexing an index.

Parameters:

taxonomyName - name of the taxonomy (must exist for index)

Returns:

the requested training RID for the specified taxonomy. The RID can be null if no training URI exists for the taxonomy.

Throws:

WcmException - exception raised in failure situation

setTaxonomyTrainingUri

public void setTaxonomyTrainingUri(String taxonomyName,
                                   URI trainingUri)
                            throws WcmException

Deprecated. as of NW04. Use setTaxonomyTrainingRid(String, RID)

Sets the URI of the root folder of the hierarchy that has been used to train/create the given taxonomy. The information about the location of the training URI is needed when reindexing an index.

Parameters:

taxonomyName - name of the taxonomy (must exist for index)

trainingUri - the training URI for the specified taxonomy

Throws:

WcmException - exception raised in failure situation

setTaxonomyTrainingRid

public void setTaxonomyTrainingRid(String taxonomyName,
                                   RID trainingRid)
                            throws WcmException

Sets the RID of the root folder of the hierarchy that has been used to train/create the given taxonomy. The information about the location of the training RID is needed when reindexing an index.

Parameters:

taxonomyName - name of the taxonomy (must exist for index)

trainingRid - the training RID for the specified taxonomy

Throws:

WcmException - exception raised in failure situation

getTaxonomyRmPrefix

public String getTaxonomyRmPrefix()

Returns:

prefix of the taxonomy repository manager. Note: it must be configured as an index management property in the wcm configuration.

useBestClasses

public boolean useBestClasses()

Returns:

if true, the best classes algorithm is used. Note: it must be configured as an index management property in the wcm configuration.

getBestClasses

public Collection getBestClasses(IResourceList resourceDocuments,
                                 String taxonomyName)
                          throws WcmException

Parameters:

resourceDocuments - resource list of documents you want to classify

taxonomyName - taxonomy for which the best classes have to be proposed

Returns:

the documents and their best classification results

Throws:

WcmException - exception raised in failure situation

getTaxonomyBestClassesSensitivity

public BestClassesSensitivity getTaxonomyBestClassesSensitivity(String taxonomyName)
                                                         throws WcmException

Gets the sensitivity level of the best classes algorithm

Parameters:

taxonomyName - name of the taxonomy (must exist for index)

Returns:

the sensitivity level for the specified taxonomy

Throws:

WcmException - exception raised in failure situation

setTaxonomyBestClassesSensitivity

public void setTaxonomyBestClassesSensitivity(String taxonomyName,
                                              BestClassesSensitivity sensitivity)
                                       throws WcmException

Sets the threshold of a taxonomy

Parameters:

taxonomyName - name of the taxonomy (must exist for index)

sensitivity - the new TaxonomyBestClassesSensitivity value

Throws:

WcmException - exception raised in failure situation

isTrainingDocument

public boolean isTrainingDocument(IResource document,
                                  RID taxonomyClassRid)
                           throws WcmException

Parameters:

document - the document to check

taxonomyClassRid - the RID of the taxonomy class that has to be checked if the document is a training document

Returns:

true, if document is a training document for the taxonomy class

Throws:

WcmException

getDocumentClassificationStatus

public ClassificationStatus getDocumentClassificationStatus(IResource document,
                                                            String taxonomyName)
                                                     throws WcmException

Gets the classification status of a document for a taxonomy

Parameters:

document - document to get the classification status for

taxonomyName - name of the taxonomy

Returns:

the documents classification status in the taxonomy

Throws:

WcmException

setDocumentClassificationStatus

public void setDocumentClassificationStatus(IResource document,
                                            String taxonomyName,
                                            ClassificationStatus status)
                                     throws WcmException

Sets the classification status of a document for a taxonomy

Parameters:

document - document to get the classification status for

taxonomyName - name of the taxonomy

Throws:

WcmException

setDocumentClassificationStatus

public void setDocumentClassificationStatus(IResource document,
                                            String taxonomyName,
                                            ClassificationStatus status,
                                            String notToSend)
                                     throws WcmException

This method is for internal usage only

Throws:

WcmException

setDocumentClassificationStatus

public void setDocumentClassificationStatus(IResource document,
                                            String taxonomyName,
                                            ClassificationStatus status,
                                            boolean sendEvents,
                                            String notToSend)
                                     throws WcmException

This method is for internal usage only

Throws:

WcmException

setDocumentClassificationStatus

public void setDocumentClassificationStatus(IResourceList documents,
                                            String taxonomyName,
                                            ClassificationStatus status)
                                     throws WcmException

Sets the classification status for a list of documents for a taxonomy

Parameters:

documents - documents to set the classification status for

taxonomyName - name of the taxonomy

Throws:

WcmException

getDocumentsToClassify

public IResourceList getDocumentsToClassify(String taxonomyName)
                                     throws WcmException

Deprecated. as of NW04. Use getDocumentsToClassify(String,IResourceContext)

Gets all documents of an index that have the status "to classify" in a taxonomy

Parameters:

taxonomyName - name of the taxonomy for which the documents that are to classify should be returned

Returns:

list of resources that are the documents "to classify" for the given taxonomy

Throws:

WcmException

getDocumentsNeverToClassify

public IResourceList getDocumentsNeverToClassify(String taxonomyName)
                                          throws WcmException

Deprecated. as of NW04. Use getDocumentsNeverToClassify(String,IResourceContext)

Gets all documents of an index that have the status "never to classify" in a taxonomy

Parameters:

taxonomyName - name of the taxonomy for which the documents that are never to be classified should be returned

Returns:

list of resources that are the documents that are "never to be classified" for the given taxonomy

Throws:

WcmException

getDocumentsToClassify

public IResourceList getDocumentsToClassify(String taxonomyName,
                                            IResourceContext context)
                                     throws WcmException

Gets all documents of an index that have the status "to classify" in a taxonomy

Parameters:

taxonomyName - name of the taxonomy for which the documents that are to classify should be returned

context - user context

Returns:

list of resources that are the documents "to classify" for the given taxonomy

Throws:

WcmException

getDocumentsNeverToClassify

public IResourceList getDocumentsNeverToClassify(String taxonomyName,
                                                 IResourceContext context)
                                          throws WcmException

Gets all documents of an index that have the status "never to classify" in a taxonomy

Parameters:

taxonomyName - name of the taxonomy for which the documents that are never to be classified should be returned

context - user context

Returns:

list of resources that are the documents that are "never to be classified" for the given taxonomy

Throws:

WcmException

getDocumentRidsToClassify

public IRidList getDocumentRidsToClassify(String taxonomyName,
                                          IResourceContext context)
                                   throws WcmException

Gets all RIDs of documents of an index that have the status "to classify" in a taxonomy

Parameters:

taxonomyName - name of the taxonomy for which the documents that are to be classified should be returned

context - user context

Returns:

list of RIDs that are the documents "to classify" for the given taxonomy

Throws:

WcmException

getDocumentRidsNeverToClassify

public IRidList getDocumentRidsNeverToClassify(String taxonomyName,
                                               IResourceContext context)
                                        throws WcmException

Gets all RIDs of documents for an index that have the status "never to classify" in a taxonomy

Parameters:

taxonomyName - name of the taxonomy for which the documents that are never to be classified should be returned

context - user context

Returns:

list of RIDs that are the documents that are "never to be classified" for the given taxonomy

Throws:

WcmException

getSpecialFolderRID

public RID getSpecialFolderRID(String taxonomyName,
                               SpecialFolder specialFolderType)
                        throws WcmException

Parameters:

taxonomyName - name of the taxonomy

specialFolderType - type of special folder

Returns:

RID of special folder within the taxonomy manager

Throws:

WcmException

getTaxonomyType

public TaxonomyType getTaxonomyType(String taxonomyName)
                             throws WcmException

Parameters:

taxonomyName - the name of the taxonomy

Returns:

the taxonomy type

Throws:

WcmException

setTaxonomyType

public void setTaxonomyType(String taxonomyName,
                            TaxonomyType taxonomyType)
                     throws WcmException

Throws:

WcmException

getDocumentTrainingClasses

public IRidList getDocumentTrainingClasses(IResource document)
                                    throws WcmException

Gets all taxonomy classes for which the document is a training document

Parameters:

document - document for which the training classes have to be returned

Returns:

RID list of taxonomy classes for which the document is a training document

Throws:

WcmException

getManuallyDeclassifiedClasses

public IRidList getManuallyDeclassifiedClasses(IResource document)
                                        throws WcmException

Parameters:

document - document for that the manually declassified classes have to be returned

Returns:

rid list of taxonomy classes for that the document is a manually declassified document

Throws:

WcmException

removeCategoryAssignments

public void removeCategoryAssignments(ICollection deletedCategoryFolder)
                               throws WcmException

Removes the assignment to a deleted category for all documents in the index

Parameters:

deletedCategoryFolder - category that has been deleted

Throws:

WcmException

autoClassifyDocs

public void autoClassifyDocs(String taxonomyName,
                             IRidList docRidList,
                             IResourceContext context)
                      throws WcmException

Requests proposals for the best categories for the documents and sets these categories automatically as document classification.
Manual classification remains for the document.

Parameters:

taxonomyName - name of the taxonomy

docRidList - list IDs of documents of a taxonomy to be reclassified

context - user context

Throws:

WcmException

autoClassifyDocs

public void autoClassifyDocs(String taxonomyName,
                             IResourceList docList,
                             IResourceContext context)
                      throws WcmException

Requests proposals for the best categories for the documents and sets these categories automatically as document classification.
Manual classification remains for the document.

Parameters:

taxonomyName - name of the taxonomy

docList - list documents of a taxonomy to be reclassified

context - user context

Throws:

WcmException

autoClassifyDocs

public void autoClassifyDocs(String taxonomyName,
                             IResourceContext context)
                      throws WcmException

Requests proposals for the best categories for documents that have no classification and sets these categories automatically as document classification.

Parameters:

taxonomyName - name of the taxonomy

context - user context

Throws:

WcmException

synchronizeTaxonomyMetaData

public void synchronizeTaxonomyMetaData(String taxonomyName)
                                 throws WcmException

Rebuilds the taxonomy meta data on the classification engine. Use this method to synchronize the taxonomy information between CM and the connected classification engine.

Parameters:

taxonomyName - taxonomy that has to be redefined

Throws:

WcmException

updateSearchCategoryAttributes

public void updateSearchCategoryAttributes(IResourceList oldResourceListe,
                                           IResourceList newResourceListe,
                                           String taxonomyName,
                                           RID categoryRid)
                                    throws WcmException

The attributes neccessary for searching in taxonomies are modified on the index server only. Thereby, the category categoryRid for the specified taxonomy is removed from the index server for all resources in oldResourceListe and added to all resources in newResourceListe.

Parameters:

oldResourceListe - resources for which category attribute is deleted.

newResourceListe - resources for which category attribute is deleted.

Throws:

WcmException - in case of an error

hasTaxonomy

public boolean hasTaxonomy(String name)

getUpdateTaxonomyState

public UpdateTaxonomyState getUpdateTaxonomyState(String taxonomyName)
                                           throws WcmException

Returns the actual state of the taxonomy with respect to an actually running update.

Parameters:

taxonomyName -

Returns:

Throws:

WcmException

getUpdateTaxonomyState

public UpdateTaxonomyState getUpdateTaxonomyState(String taxonomyName,
                                                  Locale locale)
                                           throws WcmException

Returns the actual state of the taxonomy with respect to an actually running update. With this method a state object is returned, which provides you localized messages about the state.

Parameters:

taxonomyName -

locale -

Returns:

Throws:

WcmException