AbstractClassificationIndex

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

SAP NetWeaver 7.30 SP01 KMC

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

Class AbstractClassificationIndex

java.lang.Object
  com.sapportals.wcm.service.indexmanagement.AbstractIndex
      com.sapportals.wcm.service.indexmanagement.retrieval.classification.AbstractClassificationIndex

All Implemented Interfaces:: IIndex

public abstract class AbstractClassificationIndex
extends AbstractIndex
extends AbstractIndex

The AbstractClassificationIndex offers classification functionality, which is independent from the index implementation.
Changes between major releases 7.0 and 7.X

Added methods: addOnlyAppPropManAssigned(IResource, RID) addOnlyAppPropManDeclassified(IResource, RID) classifyDocuments(IResourceList, String, float, int, boolean) getBestClasses(IResourceList, String) getBestClasses(IResourceList, String, int) getDocumentClassificationStatusNewEnum(IResource, String) getPropertyNameManuallyDeclassifiedClasses() getPropertyNameTrainingClasses() getTaxonomyTypeNewEnum(String) internalClassifyDocuments(IResourceList, String, float, int, boolean) internalClassifyDocuments(IResource, List, float, int) makeDocTaxRmRid(RID, RID, String) multiTaxonomyClassificationPossible() setOnlyAppPropertyDocClassificationStatus(IResource, String, ClassificationStatus) unfilteredClassifyDocuments(IResource, List, float, int)
Deleted methods: startTaxonomyTrainingCrawler(ICollection, boolean), startTaxonomyTrainingCrawler(String, ICollection, boolean, boolean, ISemphore)

Nested Class Summary

Nested classes/interfaces inherited from class com.sapportals.wcm.service.indexmanagement.AbstractIndex
`AbstractIndex.ErrorState, AbstractIndex.IndexingState, AbstractIndex.Reindexer, AbstractIndex.ReindexerWithoutClear, AbstractIndex.RunningState, AbstractIndex.WhatToIndex`

Field Summary
`protected Map`	`m_inboxFiller`
`protected static String`	`m_taxonomyRmPrefix`
`protected static boolean`	`m_useBestClasses`

Fields inherited from class com.sapportals.wcm.service.indexmanagement.AbstractIndex
`AS_STRING, CFG_PLUGIN_CM_INDEXES_INDEX_FOLDERS, INDEX_ALSO_AS_STRING, INDEX_STRING_AS_STRING, m_crawlerProfileId, m_indexFolders, m_indexGroup, m_indexId, m_indexName, m_isActive, m_serviceId, m_serviceUserId, PROPERTIES`

Constructor Summary
`AbstractClassificationIndex(String indexId, String indexName, String indexGroup, IIndexFolderList indexFolders, String serviceId, String serviceUserId, Properties indexServiceProperties)` Deprecated. as of NW04. Use constructor with crawler profile ID
`AbstractClassificationIndex(String indexId, String indexName, String indexGroup, IIndexFolderList indexFolders, String serviceId, String crawlerProfileId, String serviceUserId, Properties indexServiceProperties)`

Method Summary
`void`	`addOnlyAppPropManAssigned(IResource document, com.sapportals.wcm.util.uri.RID category)` Only for internal usage.
`void`	`addOnlyAppPropManDeclassified(IResource document, com.sapportals.wcm.util.uri.RID category)` Only for internal usage.
`protected void`	`addResourceToClassificationIndex(com.sapportals.wcm.util.uri.RID resourceRID, IResourceContext context)` Adds a resource to the list of resources that are index in the index.
`void`	`addTaxonomy(String taxonomy)` Deprecated. as of NW04. Use `addTaxonomy(String,IResourceContext)`
`void`	`addTaxonomy(String taxonomy, IResourceContext context)` Add Taxonomy to the AbstractClassificationIndex object.
`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, com.sapportals.wcm.util.uri.IRidList docRidList, IResourceContext context)` Requests proposals for the best categories for the documents and sets these categories automatically as document classification.
`void`	`checkUpdateTaxonomyStateDuringStartUp()` only for internal usage
`Collection`	`classifyDocuments(IResourceList resourceDocuments, String taxonomyName)` Classifies documents (which taxonomy class folders do the documents fit best)
`Collection`	`classifyDocuments(IResourceList resourceDocuments, String taxonomyName, float threshold, int maxResults)` Classifies documents (which taxonomy class folders do the documents fit best).
`Collection`	`classifyDocuments(IResourceList resourceDocuments, String taxonomyName, float threshold, int maxResults, boolean checkIfInIndex)` Classifies documents (which taxonomy class folders do the documents fit best).
`Collection`	`classifyDocuments(IResourceList resourceDocuments, String taxonomyName, int maxResults)` Classifies documents (which taxonomy class folders do the documents fit best)
`static void`	`clearGuidCache()` only for internal usage
`protected ICollection`	`createTaxRmIndexFolder(IResourceContext context)` Creates the folder that represents the index in the taxonomy repository.
`void`	`deleteClassificationProperties(IResource resource)` Deletes all classification properties of a document; used to delete properties of old versions Only for internal usage
`void`	`deleteIndexTaxDocClassification(com.sapportals.wcm.util.uri.IRidList documentIDs)` Deletes the classification of the documents regarding the taxonomies of this index.
`protected void`	`deleteTaxRmIndexFolder(IResourceContext context)` Deletes the whole folder hierarchy of an index in the taxonomy repository.
`void`	`finishXPostClear()` Only for internal usage.
`static void`	`getAllCollections(ICollection col, IResourceList resources)` Coolects all collections below col in resources.
`Collection`	`getBestClasses(IResourceList resourceDocuments, String taxonomyName)`
`Collection`	`getBestClasses(IResourceList resourceDocuments, String taxonomyName, int maxNumberOfDocs)`
`Collection`	`getBestClasses(IResourceList resourceDocuments, String taxonomyName, Map thresholds)` This method is not used anywhere.
`Collection`	`getBestClassesOld(IResourceList resourceDocuments, String taxonomyName)` This class is not used because it implements an unreasonable algorithm.
`com.sapportals.wcm.util.uri.IRidList`	`getClassDeclassifiedDocuments(com.sapportals.wcm.util.uri.RID categoryRid, IResourceContext context)` Returns the manyually declassified resourced for the category.
`com.sapportals.wcm.util.uri.IRidList`	`getClassDeclassifiedDocuments(com.sapportals.wcm.util.uri.RID categoryRid, IResourceContext context, IApplicationProperties appPropService)` Returns the manyually declassified resourced for the category.
`com.sapportals.wcm.util.uri.IRidList`	`getClassDocumentRids(ICollection taxonomyClass)` Gets the resource IDs of all documents of a taxonomy class
`com.sapportals.wcm.util.uri.IRidList`	`getClassDocumentRids(ICollection taxonomyClass, List appPropServices)` Gets the resource IDs of all documents of a taxonomy class whereby the parameter appPropServices should contain the application property service.
`com.sapportals.wcm.util.uri.IRidList`	`getClassDocumentRids(com.sapportals.wcm.util.uri.RID taxonomyClassRid, IResourceContext context)` Gets the resource IDs of all documents of a taxonomy class
`com.sapportals.wcm.util.uri.IRidList`	`getClassDocumentRids(com.sapportals.wcm.util.uri.RID taxonomyClassRid, IResourceContext context, List appPropertyServices)` Gets the resource IDs of all documents of a taxonomy class whereby the parameter appPropServices should contain the application property service.
`IResourceList`	`getClassDocuments(ICollection taxonomyClass)` Gets all documents of a taxonomy class
`IResourceList`	`getClassDocuments(com.sapportals.wcm.util.uri.RID taxonomyClassRid, IResourceContext context)` Gets all documents of a taxonomy class
`List`	`getClassesStringList(IDocClassificationMap documentClassification)` List of strings representing the classes in the parameter.
`com.sapportals.wcm.util.uri.IRidList`	`getClassTrainingDocuments(com.sapportals.wcm.util.uri.RID categoryRid, IResourceContext context)` Returns the training documents of a category.
`com.sapportals.wcm.util.uri.IRidList`	`getClassTrainingDocuments(com.sapportals.wcm.util.uri.RID categoryRid, IResourceContext context, IApplicationProperties appPropService)` Returns the training documents of a category.
`IDocClassificationMap`	`getDocClassification(IResource document)` Gets the classification that has been set for the document.
`IDocClassificationMap`	`getDocClassification(IResource document, IResourceContext context)` Gets the classification that has been set for the document.
`IDocClassificationMapList`	`getDocListClassification(IResourceList documents)` Gets the classifications that have been set for the documents.
`IDocClassificationMapList`	`getDocListClassification(IResourceList documents, IResourceContext context)` Gets the classifications that have been set for the documents.
`Map`	`getDocumentClassification(IResource document)` Deprecated. as of NW04. Use getDocClassification(IResource)
`ClassificationStatus`	`getDocumentClassificationStatus(IResource document, String taxonomyName)` Deprecated. use new enums package for jdk 1.5 compatibility
`ClassificationStatus`	`getDocumentClassificationStatusNewEnum(IResource document, String taxonomyName)` Gets the classification status of a document for a taxonomy
`static com.sapportals.wcm.util.uri.RID`	`getDocumentReplaceName(com.sapportals.wcm.util.uri.RID documentRid)` only for internal usage
`com.sapportals.wcm.util.uri.IRidList`	`getDocumentRidsNeverToClassify(String taxonomyName, IResourceContext context)` Gets all rids of documents of an index that have the status "never to classify" within a taxonomy
`com.sapportals.wcm.util.uri.IRidList`	`getDocumentRidsToClassify(String taxonomyName, IResourceContext context)` Gets all rids of documents of an index that have the status "to classify" within a taxonomy
`IResourceList`	`getDocumentsNeverToClassify(String taxonomyName)` Deprecated. as of NW04.
`IResourceList`	`getDocumentsNeverToClassify(String taxonomyName, IResourceContext context)` Gets all documents of an index that have the status "never to classify" within a taxonomy
`IResourceList`	`getDocumentsToClassify(String taxonomyName)` Deprecated. as of NW04.
`IResourceList`	`getDocumentsToClassify(String taxonomyName, IResourceContext context)` Gets all documents of an index that have the status "to classify" within a taxonomy
`static com.sapportals.wcm.util.uri.RID`	`getDocumentTaxRMRid(com.sapportals.wcm.util.uri.RID taxonomyClassRid, com.sapportals.wcm.util.uri.RID documentRid)` only for internal usage
`static Map`	`getDocumentTaxRMRids(com.sapportals.wcm.util.uri.RID taxonomyClassRid, IResourceList documents)` only for internal usage
`com.sapportals.wcm.util.uri.IRidList`	`getDocumentTrainingClasses(IResource document)`
`com.sapportals.wcm.util.uri.IRidList`	`getManuallyDeclassifiedClasses(IResource document)`
`static IPropertyName`	`getPropertyNameManuallyDeclassifiedClasses()`
`protected IPropertyName`	`getPropertyNameTaxonomy(String taxonomyName)`
`static IPropertyName`	`getPropertyNameTrainingClasses()`
`IQueryFolder`	`getQueryFolder(com.sapportals.wcm.util.uri.RID taxonomyClassRid)` Gets a query folder instance
`static com.sapportals.wcm.util.uri.RID`	`getRIDFromConstantID(String guid)` only for internal usage
`com.sapportals.wcm.util.uri.RID`	`getSpecialFolderRID(String taxonomyName, SpecialFolder specialFolderType)`
`static com.sapportals.wcm.util.uri.RID`	`getTargetRIDFromReplaceName(com.sapportals.wcm.util.uri.RID linkRid)` only for internal usage
`List`	`getTaxonomies()` Get the Taxonomies attribute of the AbstractClassificationIndex object.
`BestClassesSensitivity`	`getTaxonomyBestClassesSensitivity(String taxonomyName)` Gets the sensitivity level of the best classes algorithm
`float`	`getTaxonomyBestClassesSensitivityValue(String taxonomyName)` Returns the threshold value used for the taxonomy.
`float`	`getTaxonomyClassificationThreshold(String taxonomyName, String thresholdId)` Gets the threshold of a taxonomy
`String`	`getTaxonomyRmPrefix()` Get the TaxonomyRmPrefix attribute of the AbstractClassificationIndex object.
`com.sapportals.wcm.util.uri.RID`	`getTaxonomyTrainingRid(String taxonomyName)` Gets the uri of the root folder of the hierarchy that has been used to train/create the given taxonomy.
`com.sapportals.wcm.util.uri.URI`	`getTaxonomyTrainingUri(String taxonomyName)` Deprecated. as of NW04. Use getTaxonomyTrainingRid(String)
`TaxonomyType`	`getTaxonomyType(String taxonomyName)` Deprecated. use new enums package for jdk 1.5 compatibility
`TaxonomyType`	`getTaxonomyTypeNewEnum(String taxonomyName)`
`UpdateTaxonomyState`	`getUpdateTaxonomyState(String taxonomyName)` Returns the status of the taxonomy with respect to an update operation.
`UpdateTaxonomyState`	`getUpdateTaxonomyState(String taxonomyName, Locale locale)` Returns the status of the taxonomy with respect to an update operation.
`boolean`	`hasTaxonomy(String name)` Returns true if the index has a taxonomy with the specified name.
`void`	`indexDocument(IResource resource, String taxonomyName, com.sapportals.wcm.util.uri.IRidList taxonomyClasses, boolean isSearchRelevant)` indexes a document (method for internal use)
`void`	`indexDocument(IResource resource, String taxonomyName, com.sapportals.wcm.util.uri.IUriList taxonomyClasses, boolean isSearchRelevant)` Deprecated. as of NW04. Use indexDocument(IResource, String, IRidList, boolean)
`protected abstract void`	`indexDocumentClassification(IResource document, IIndexService indexService)`
`void`	`indexDocuments(IResourceList resources)` Indexes a list of documents
`void`	`indexDocuments(IResourceList resources, boolean reindexMode, boolean sendLinkEvents)` Indexes a list of documents
`void`	`indexDocuments(IResourceList resources, String taxonomyName, com.sapportals.wcm.util.uri.IRidList taxonomyClasses, boolean isSearchRelevant)` Indexes a list of documents (method for internal use)
`void`	`indexDocuments(IResourceList resources, String taxonomyName, com.sapportals.wcm.util.uri.IUriList taxonomyClasses, boolean isSearchRelevant)` Deprecated. as of NW04. Use indexDocuments(IResourceList, String, IRidList, boolean)
`void`	`indexManualTrainDocs()` Only for internal usage.
`void`	`initTaxonomies(List taxonomies)` Sets the index taxonomies initially before generating the index.
`protected Map`	`internalClassifyDocuments(IResource resource, List taxonomies, float threshold, int maxResults)`
`protected Collection`	`internalClassifyDocuments(IResourceList resourceDocuments, String taxonomyName, float threshold, int maxResults)` Classifies documents (which taxonomy class folders do the documents fit best)
`protected Collection`	`internalClassifyDocuments(IResourceList resourceDocuments, String taxonomyName, float threshold, int maxResults, boolean checkIfInIndex)` Classifies documents (which taxonomy class folders do the documents fit best).
`protected void`	`internalIndexDocuments(IResourceList resources, IResourceEvent resourceEvent)` indexes a list of documents (method for internal use)
`protected abstract void`	`internalIndexDocuments(IResourceList resources, String taxonomyName, com.sapportals.wcm.util.uri.IRidList taxonomyClasses, IResourceEvent resourceEvent, boolean isSearchRelevant, boolean reindexMode, boolean sendLinkEvents)` Indexes a list of documents (method for internal use)
`boolean`	`isDocClassifiedInAnyTax(IResource resource)` Checks if the resource is assigned to any category.
`boolean`	`isIndexOnlyClassifiedDocs()` Returns true, if only documents are indexed, which could be assigned to categories.
`boolean`	`isManuallyDeclassifiedDocument(IResource document, com.sapportals.wcm.util.uri.RID taxonomyClassRid)`
`boolean`	`isTrainingDocument(IResource document, com.sapportals.wcm.util.uri.RID taxonomyClassRid)`
`static com.sapportals.wcm.util.uri.RID`	`makeDocTaxRmRid(com.sapportals.wcm.util.uri.RID taxonomyClassRid, com.sapportals.wcm.util.uri.RID documentRid, String docGuid)` only for internal usage
`boolean`	`multiTaxonomyClassificationPossible()` Returns true if the index support classification calls for more than one taxonomy
`protected boolean`	`reindexTrainingResources(IIndexFolderList preClearIndexFolders)` Only for internal usage.
`void`	`removeCategoryAssignments(ICollection deletedCategoryFolder)` Removes the assignment of all documents of the index to a category.
`protected void`	`removeResourceFromClassificationIndex(com.sapportals.wcm.util.uri.RID resourceRID, IResourceContext context)` Removes a resource from the list of resources that are indexed in the index.
`void`	`removeTaxonomy(String taxonomy)` Deprecated. as of NW04. Use `removeTaxonomy(String,IResourceContext)`
`void`	`removeTaxonomy(String taxonomy, IResourceContext context)` for internal use - to remove a taxonomy delete the taxonomy collection
`void`	`setDocClassification(IDocClassificationMap documentClassificationMap)` Stores the document classification that has been choosen by manual or automatic classification.
`void`	`setDocClassification(IDocClassificationMap documentClassificationMap, boolean indexDocumentClassification)` Stores the document classification that has been choosen by manual or automatic classification.
`void`	`setDocClassification(IDocClassificationMap documentClassificationMap, boolean indexDocumentClassification, boolean isTrainingDocument)` Stores the document classification that has been choosen by manual or automatic classification.
`void`	`setDocClassification(IDocClassificationMap documentClassificationMap, boolean indexDocumentClassification, boolean isTrainingDocument, boolean sendLinkEvents)` Stores the document classification that has been choosen by manual or automatic classification.
`void`	`setDocClassification(IDocClassificationMap documentClassificationMap, boolean indexDocumentClassification, boolean isTrainingDocument, boolean sendLinkEvents, String notToSend)` Stores the document classification that has been choosen by manual or automatic classification.
`void`	`setDocClassification(IDocClassificationMap documentClassificationMap, String notToSend)` Stores the document classification that has been choosen by manual or automatic classification.
`void`	`setDocListClassification(IDocClassificationMapList documentClassificationMapList)` Stores the documents classifications that has been choosen 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)` Sets the classification status of a document for a taxonomy
`void`	`setDocumentClassificationStatus(IResource document, String taxonomyName, ClassificationStatus status, String notToSend)` Sets the classification status of a document for a taxonomy
`void`	`setIndexOnlyClassifiedDocs(boolean indexOnlyClassifiedDocs)` If set on true, only documents are indexed, which are also assigned to categories, otherwise all documents are indexed.
`void`	`setOnlyAppPropertyDocClassificationStatus(IResource document, String taxonomyName, ClassificationStatus status)` Only for internal usage.
`void`	`setQueryFolderExternalFast(IQueryFolder queryFolder, IQueryEntryList query)` only for internal usage
`void`	`setTaxonomyBestClassesSensitivity(String taxonomyName, BestClassesSensitivity sensitivity)` Sets the threshold of a taxonomy
`void`	`setTaxonomyClassificationThreshold(String taxonomyName, String thresholdId, float threshold)` Set the TaxonomyClassificationThreshold attribute of the AbstractClassificationIndex object.
`void`	`setTaxonomyTrainingRid(String taxonomyName, com.sapportals.wcm.util.uri.RID trainingRid)` Set the TaxonomyTrainingUri attribute of the AbstractClassificationIndex object.
`void`	`setTaxonomyTrainingUri(String taxonomyName, com.sapportals.wcm.util.uri.URI trainingUri)` Deprecated. as of NW04. Use setTaxonomyTrainingRid(String,RID)
`void`	`setTaxonomyType(String taxonomyName, TaxonomyType taxonomyType)` Deprecated. use new enums package for jdk 1.5 compatibility
`void`	`setUpdateTaxonomyState(String state, String taxonomyName, int visitedCategories, int catgoriesToUpdate, int allCategories)` only for internal usage
`void`	`synchronizeTaxonomyMetaData(String taxonomyName)` Rebuilds the taxonomy meta data on the classification engine.
`Map`	`unfilteredClassifyDocuments(IResource resource, List taxonomies, float threshold, int maxResults)` Classifies document according several taxonomies (which taxonomy class folders do the document fit best)
`Collection`	`unfilteredClassifyDocuments(IResourceList resourceDocuments, String taxonomyName, float threshold, int maxResults)` Classifies documents (which taxonomy class folders do the documents fit best)
`abstract void`	`updateCategoryContents(String taxonomyName, boolean dirtyOnly, IResourceContext context)` Starts a process that checks and updates categories of a taxonomy where the query is not in sync with the documents of category.
`boolean`	`useBestClasses()`

Methods inherited from class com.sapportals.wcm.service.indexmanagement.AbstractIndex
addFolderUri, changeIndexedDocumentProperties, changeIndexedDocumentProperties, changeIndexedDocumentProperties, checkIndexIsActive, checkProperties, clearPropertiesCache, compareTo, convertDateToIndexTime, convertStringPropertiesToObjects, createIndexOnServer, deindex, deindexDocument, deindexDocument, deindexDocument, deindexDocuments, deindexDocuments, deindexDocuments, deleteOnServer, deleteOnServer, deltaReindex, equals, escape, escape, flush, flush, flushAsync, flushAsync, getActiveTime, getClassProperties, getContent, getCrawlerProfileId, getDetailsMonitorPageText, getDetailsMonitorPageURL, getDetailsMonitorURL1, getDetailsMonitorURL2, getDetailsMonitorURL3, getDisplayNameAsStringPropName, getDocumentFeaturesPropName, getErrorState, getFolderUris, getFrameSizes, getHiddenIndexAreaStartRid, getHiddenIndexIds, getHighlightedContent, getHighlightedContent, getIndexedProperties, getIndexedProperties, getIndexFolderForDocument, getIndexFolderRidPropName, getIndexFolders, getIndexGroup, getIndexId, getIndexingState, getIndexName, getIndexOnlyPropertiesPropName, getLanguagesOfIndexedDocuments, getLanguagesOfIndexedDocuments, getLogicalOrPhysicalPropName, getModeledPropertyIndexType, getModeledPropertyIndexType, getNumberOfCrawler, getNumberOfDocumentsInQueue, getNumberOfErrors, getNumberOfIndexedDocuments, getNumberOfIndexErrors, getNumberOfSuccessfullyIndexedDocs, getOriginalContent, getProperties, getPropertiesAsStrings, getPropertiesForHiddenResource, getQueryExtender, getResourceInfo, getRID, getRunningState, getSchedulerTimeTable, getSecManager, getServiceErrorRids, getServiceId, getServiceTypes, getSimilarClasses, getSupportedOptions, getSystemList, getWhatToIndex, getWhatToIndexString, indexContentOfExternalLinks, indexDocument, indexDocument, indexDocuments, indexExistsAndReadyForDeleteOrClear, indexInternalLinks, indexStringAttributeAsString, init, internalDeindexDocuments, internalSetIndexFolders, isActive, isInSystemFolder, isLogicalVariant, isPhysicalVariant, onlyVirtualDatasources, reduceNumberOfCrawler, reindex, reindex, reindexNotTrainingDocs, reindexWithoutClear, reindexXPostClear, removeAllFolderUris, removeFolderUri, repaireConfigurable, restartAll, resumeAll, setActive, setActiveDuringStartup, setClassProperties, setCrawlerProfileId, setInactiveIndexHasChanged, setIndexGroup, setIndexingState, setIndexName, setNumberOfCrawler, setProperties, setQueryExtender, setSchedulerTimeTable, setStateAndNumberOfCrawler, setWhatToIndex, startReindexer, startReindexerWithoutClear, stopAll, suspendAll, typeShouldBeIndexed, unescape, unescape

Methods inherited from class com.sapportals.wcm.service.indexmanagement.AbstractIndex

addFolderUri, changeIndexedDocumentProperties, changeIndexedDocumentProperties, changeIndexedDocumentProperties, checkIndexIsActive, checkProperties, clearPropertiesCache, compareTo, convertDateToIndexTime, convertStringPropertiesToObjects, createIndexOnServer, deindex, deindexDocument, deindexDocument, deindexDocument, deindexDocuments, deindexDocuments, deindexDocuments, deleteOnServer, deleteOnServer, deltaReindex, equals, escape, escape, flush, flush, flushAsync, flushAsync, getActiveTime, getClassProperties, getContent, getCrawlerProfileId, getDetailsMonitorPageText, getDetailsMonitorPageURL, getDetailsMonitorURL1, getDetailsMonitorURL2, getDetailsMonitorURL3, getDisplayNameAsStringPropName, getDocumentFeaturesPropName, getErrorState, getFolderUris, getFrameSizes, getHiddenIndexAreaStartRid, getHiddenIndexIds, getHighlightedContent, getHighlightedContent, getIndexedProperties, getIndexedProperties, getIndexFolderForDocument, getIndexFolderRidPropName, getIndexFolders, getIndexGroup, getIndexId, getIndexingState, getIndexName, getIndexOnlyPropertiesPropName, getLanguagesOfIndexedDocuments, getLanguagesOfIndexedDocuments, getLogicalOrPhysicalPropName, getModeledPropertyIndexType, getModeledPropertyIndexType, getNumberOfCrawler, getNumberOfDocumentsInQueue, getNumberOfErrors, getNumberOfIndexedDocuments, getNumberOfIndexErrors, getNumberOfSuccessfullyIndexedDocs, getOriginalContent, getProperties, getPropertiesAsStrings, getPropertiesForHiddenResource, getQueryExtender, getResourceInfo, getRID, getRunningState, getSchedulerTimeTable, getSecManager, getServiceErrorRids, getServiceId, getServiceTypes, getSimilarClasses, getSupportedOptions, getSystemList, getWhatToIndex, getWhatToIndexString, indexContentOfExternalLinks, indexDocument, indexDocument, indexDocuments, indexExistsAndReadyForDeleteOrClear, indexInternalLinks, indexStringAttributeAsString, init, internalDeindexDocuments, internalSetIndexFolders, isActive, isInSystemFolder, isLogicalVariant, isPhysicalVariant, onlyVirtualDatasources, reduceNumberOfCrawler, reindex, reindex, reindexNotTrainingDocs, reindexWithoutClear, reindexXPostClear, removeAllFolderUris, removeFolderUri, repaireConfigurable, restartAll, resumeAll, setActive, setActiveDuringStartup, setClassProperties, setCrawlerProfileId, setInactiveIndexHasChanged, setIndexGroup, setIndexingState, setIndexName, setNumberOfCrawler, setProperties, setQueryExtender, setSchedulerTimeTable, setStateAndNumberOfCrawler, setWhatToIndex, startReindexer, startReindexerWithoutClear, stopAll, suspendAll, typeShouldBeIndexed, unescape, unescape

Methods inherited from class java.lang.Object
`clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.sapportals.wcm.service.indexmanagement.IIndex
`clear, delete, delete, generate, generate, getResourceInfo, getServiceTypes`

Field Detail

m_taxonomyRmPrefix

protected static String m_taxonomyRmPrefix

m_useBestClasses

protected static boolean m_useBestClasses

m_inboxFiller

protected Map m_inboxFiller

Constructor Detail

AbstractClassificationIndex

public AbstractClassificationIndex(String indexId,
                                   String indexName,
                                   String indexGroup,
                                   IIndexFolderList indexFolders,
                                   String serviceId,
                                   String serviceUserId,
                                   Properties indexServiceProperties)
                            throws com.sapportals.wcm.WcmException

Deprecated. as of NW04. Use constructor with crawler profile ID

Parameters:: indexId - index identifier; indexName - display name of the index; indexGroup - the group the index has been assigned to; serviceId - the identifier of the index service; serviceUserId - id of the index management service user, to set the service context; indexServiceProperties - config properties of the index management service; folderRids - list of rids that are assigned to the index
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

AbstractClassificationIndex

public AbstractClassificationIndex(String indexId,
                                   String indexName,
                                   String indexGroup,
                                   IIndexFolderList indexFolders,
                                   String serviceId,
                                   String crawlerProfileId,
                                   String serviceUserId,
                                   Properties indexServiceProperties)
                            throws com.sapportals.wcm.WcmException

Parameters:: indexId - index identifier; indexName - display name of the index; indexGroup - the group the index has been assigned to; serviceId - the identifier of the index service; crawlerProfileId - - ID of the default crawler profile for all index folders of the index; serviceUserId - id of the index management service user, to set the service context; indexServiceProperties - config properties of the index management service; folderRids - list of rids that are assigned to the index
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

Method Detail

setDocumentClassification

public void setDocumentClassification(IResource document,
                                      Map classification)
                               throws com.sapportals.wcm.WcmException

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

This call stores the document classification that has been choosen by manual or automatic classification.

Parameters:: document - The new DocumentClassification value; classification - The new DocumentClassification value
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

setDocumentClassification

public void setDocumentClassification(IResource document,
                                      Map classification,
                                      boolean indexDocumentClassification)
                               throws com.sapportals.wcm.WcmException

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

This call stores the document classification that has been choosen by manual or automatic classification.

Parameters:: document - The new DocumentClassification value; classification - The new DocumentClassification value; indexDocumentClassification - The new DocumentClassification value
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

setDocumentClassification

public void setDocumentClassification(IResource document,
                                      Map classification,
                                      boolean indexDocumentClassification,
                                      boolean isTrainingDocument)
                               throws com.sapportals.wcm.WcmException

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

Stores the document classification that has been choosen by manual or automatic classification.

Parameters:: document - document for that the classification has to be set.; classification - map with document classification. Key is (String) taxonomy name. Value is IRidList of taxonomy class rids. The entire document classification must be set. To add classes first get the old document classification and add the new classes. To remove classes get the old document classification and remove the classes from the class list. To delete a whole taxonomy for the document set an empty class list for the taxonomy name.; 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 imediately before or after the call by another routine.; isTrainingSet - if true the added classes are indexed to train the index
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

isTrainingDocument

public boolean isTrainingDocument(IResource document,
                                  com.sapportals.wcm.util.uri.RID taxonomyClassRid)
                           throws com.sapportals.wcm.WcmException

Parameters:: document - the document to check; taxonomyClassRid - the rid of the taxonomy class for that has to be checked if the document is a training document if taxonomyClassRid is null, it returns true if the document is a training document for any taxonomy category of the index.
Returns:: true if document is a training document for the taxonomy class
Throws:: com.sapportals.wcm.WcmException

isDocClassifiedInAnyTax

public boolean isDocClassifiedInAnyTax(IResource resource)
                                throws com.sapportals.wcm.WcmException

Checks if the resource is assigned to any category.

Parameters:: resource -
Returns:
Throws:: com.sapportals.wcm.WcmException

isManuallyDeclassifiedDocument

public boolean isManuallyDeclassifiedDocument(IResource document,
                                              com.sapportals.wcm.util.uri.RID taxonomyClassRid)
                                       throws com.sapportals.wcm.WcmException

Parameters:: document - the document to check; taxonomyClassRid - the rid of the taxonomy class for that has to be checked if the document is a manually declassified document if taxonomyClassRid is null, it returns true if the document is a manually declassified document for any taxonomy category of the index.
Returns:: true if document is a manually declassified document for the taxonomy class
Throws:: com.sapportals.wcm.WcmException

setTaxonomyClassificationThreshold

public void setTaxonomyClassificationThreshold(String taxonomyName,
                                               String thresholdId,
                                               float threshold)
                                        throws com.sapportals.wcm.WcmException

Set the TaxonomyClassificationThreshold attribute of the AbstractClassificationIndex object.

Parameters:: taxonomyName - The new TaxonomyClassificationThreshold value; thresholdId - The new TaxonomyClassificationThreshold value; threshold - The new TaxonomyClassificationThreshold value
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

setTaxonomyTrainingUri

public void setTaxonomyTrainingUri(String taxonomyName,
                                   com.sapportals.wcm.util.uri.URI trainingUri)
                            throws com.sapportals.wcm.WcmException

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

Set the TaxonomyTrainingUri attribute of the AbstractClassificationIndex object.

Parameters:: taxonomyName - The new TaxonomyTrainingUri value; trainingUri - The new TaxonomyTrainingUri value
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

setTaxonomyTrainingRid

public void setTaxonomyTrainingRid(String taxonomyName,
                                   com.sapportals.wcm.util.uri.RID trainingRid)
                            throws com.sapportals.wcm.WcmException

Set the TaxonomyTrainingUri attribute of the AbstractClassificationIndex object.

Parameters:: taxonomyName - The new TaxonomyTrainingRid value; trainingRid - The new TaxonomyTrainingRid value
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

setTaxonomyBestClassesSensitivity

public void setTaxonomyBestClassesSensitivity(String taxonomyName,
                                              BestClassesSensitivity sensitivity)
                                       throws com.sapportals.wcm.WcmException

Sets the threshold of a taxonomy

Parameters:: taxonomyName - name of the taxonomy (must exist for index); sensitivity - The new TaxonomyBestClassesSensitivity value
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

hasTaxonomy

public boolean hasTaxonomy(String name)

Returns true if the index has a taxonomy with the specified name.

Parameters:: name -
Returns:

getTaxonomies

public List getTaxonomies()

Get the Taxonomies attribute of the AbstractClassificationIndex object.

Returns:: The Taxonomies value

getDocumentClassification

public Map getDocumentClassification(IResource document)
                              throws com.sapportals.wcm.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 classify documents. It only gives the document classes set by setDocumentClassification();

Parameters:: document - Document to get the classification for
Returns:: The DocumentClassification value
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

getTaxonomyClassificationThreshold

public float getTaxonomyClassificationThreshold(String taxonomyName,
                                                String thresholdId)
                                         throws com.sapportals.wcm.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:: com.sapportals.wcm.WcmException - Exception raised in failure situation

getTaxonomyTrainingUri

public com.sapportals.wcm.util.uri.URI getTaxonomyTrainingUri(String taxonomyName)
                                                       throws com.sapportals.wcm.WcmException

Deprecated. as of NW04. Use getTaxonomyTrainingRid(String)

Throws:: com.sapportals.wcm.WcmException

getTaxonomyTrainingRid

public com.sapportals.wcm.util.uri.RID getTaxonomyTrainingRid(String taxonomyName)
                                                       throws com.sapportals.wcm.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 necessary 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 may be null if no training uri exists for the taxonomy.
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

getTaxonomyRmPrefix

public String getTaxonomyRmPrefix()

Get the TaxonomyRmPrefix attribute of the AbstractClassificationIndex object.

Returns:: The TaxonomyRmPrefix value

getClassDocuments

public IResourceList getClassDocuments(ICollection taxonomyClass)
                                throws com.sapportals.wcm.WcmException,
                                       ResourceException

Gets all documents of a taxonomy class

Parameters:: taxonomyClass - the taxonomy class folder you want to have documents for
Returns:: resource list of taxonomy class documents
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation; ResourceException - Exception raised in failure situation

getClassDocuments

public IResourceList getClassDocuments(com.sapportals.wcm.util.uri.RID taxonomyClassRid,
                                       IResourceContext context)
                                throws com.sapportals.wcm.WcmException,
                                       ResourceException

Gets all documents of a taxonomy class

Parameters:: taxonomyClassRid - resource ID of the taxonomy class you want to have documents for; context - user context
Returns:: resource list of taxonomy class documents
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation; ResourceException - Exception raised in failure situation

getClassDocumentRids

public com.sapportals.wcm.util.uri.IRidList getClassDocumentRids(ICollection taxonomyClass)
                                                          throws com.sapportals.wcm.WcmException,
                                                                 ResourceException

Gets the resource IDs of all documents of a taxonomy class

Parameters:: taxonomyClass - the taxonomy class folder you want to have documents for
Returns:: resource ID list of taxonomy class documents
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation; ResourceException - Exception raised in failure situation

getClassDocumentRids

public com.sapportals.wcm.util.uri.IRidList getClassDocumentRids(ICollection taxonomyClass,
                                                                 List appPropServices)
                                                          throws com.sapportals.wcm.WcmException,
                                                                 ResourceException

Gets the resource IDs of all documents of a taxonomy class whereby the parameter appPropServices should contain the application property service. Formerly it was planned that repository managers might have their own implementation of an application property service but this is not valid anymore making this parameter superfluous.

Parameters:: taxonomyClass -; appPropServices -
Returns:
Throws:: com.sapportals.wcm.WcmException; ResourceException

getClassDocumentRids

public com.sapportals.wcm.util.uri.IRidList getClassDocumentRids(com.sapportals.wcm.util.uri.RID taxonomyClassRid,
                                                                 IResourceContext context)
                                                          throws com.sapportals.wcm.WcmException

Gets the resource IDs of all documents of a taxonomy class

Parameters:: taxonomyClassRid - resource ID of the taxonomy class you want to have documents for; context - user context
Returns:: resource ID list of taxonomy class documents
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation; ResourceException - Exception raised in failure situation

getClassDocumentRids

public com.sapportals.wcm.util.uri.IRidList getClassDocumentRids(com.sapportals.wcm.util.uri.RID taxonomyClassRid,
                                                                 IResourceContext context,
                                                                 List appPropertyServices)
                                                          throws com.sapportals.wcm.WcmException

Parameters:: taxonomyClassRid -; context -; appPropertyServices -
Returns:
Throws:: com.sapportals.wcm.WcmException

getBestClassesOld

public Collection getBestClassesOld(IResourceList resourceDocuments,
                                    String taxonomyName)
                             throws com.sapportals.wcm.WcmException

This class is not used because it implements an unreasonable algorithm.

Parameters:: resourceDocuments - Resource list of documents you want to classify; taxonomyName - taxonomy for that the best classes have to be proposed for
Returns:: the documents and their best classification results
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

getBestClasses

public Collection getBestClasses(IResourceList resourceDocuments,
                                 String taxonomyName)
                          throws com.sapportals.wcm.WcmException

Parameters:: resourceDocuments - Resource list of documents you want to classify; taxonomyName - taxonomy for that the best classes have to be proposed for
Returns:: the documents and their 20 best classification results
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

getBestClasses

public Collection getBestClasses(IResourceList resourceDocuments,
                                 String taxonomyName,
                                 int maxNumberOfDocs)
                          throws com.sapportals.wcm.WcmException

Parameters:: resourceDocuments - Resource list of documents you want to classify; taxonomyName - taxonomy for that the best classes have to be proposed for; taxonomyName - max number of results per document
Returns:: the documents and their maxNumberOfDocs best classification results
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

getBestClasses

public Collection getBestClasses(IResourceList resourceDocuments,
                                 String taxonomyName,
                                 Map thresholds)
                          throws com.sapportals.wcm.WcmException

This method is not used anywhere.

Parameters:: resourceDocuments - Resource list of documents you want to classify; taxonomyName - taxonomy for that the best classes have to be proposed for; thresholds - class specific thresholds
Returns:: the documents and their maxNumberOfDocs best classification results
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

getTaxonomyBestClassesSensitivity

public BestClassesSensitivity getTaxonomyBestClassesSensitivity(String taxonomyName)
                                                         throws com.sapportals.wcm.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:: com.sapportals.wcm.WcmException - Exception raised in failure situation

getTaxonomyBestClassesSensitivityValue

public float getTaxonomyBestClassesSensitivityValue(String taxonomyName)
                                             throws com.sapportals.wcm.WcmException

Returns the threshold value used for the taxonomy.

Parameters:: taxonomyName -
Returns:
Throws:: com.sapportals.wcm.WcmException

initTaxonomies

public void initTaxonomies(List taxonomies)

Sets the index taxonomies initially before generating the index. After creating the index the taxonomy folders are created automatically.

Parameters:: taxonomies - list of taxonomy names

removeTaxonomy

public void removeTaxonomy(String taxonomy)

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

for internal use - to remove a taxonomy delete the taxonomy collection

Parameters:: taxonomyName - name of the taxonomy to remove

removeTaxonomy

public void removeTaxonomy(String taxonomy,
                           IResourceContext context)
                    throws com.sapportals.wcm.WcmException

for internal use - to remove a taxonomy delete the taxonomy collection

Parameters:: taxonomyName - name of the taxonomy to remove
Throws:: com.sapportals.wcm.WcmException

addTaxonomy

public void addTaxonomy(String taxonomy)
                 throws com.sapportals.wcm.WcmException

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

Add Taxonomy to the AbstractClassificationIndex object.

Parameters:: taxonomy - Taxonomy to be added
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

addTaxonomy

public void addTaxonomy(String taxonomy,
                        IResourceContext context)
                 throws com.sapportals.wcm.WcmException

Add Taxonomy to the AbstractClassificationIndex object.

Parameters:: taxonomy - Taxonomy to be added
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

indexDocuments

public void indexDocuments(IResourceList resources,
                           String taxonomyName,
                           com.sapportals.wcm.util.uri.IUriList taxonomyClasses,
                           boolean isSearchRelevant)
                    throws ResourceException,
                           com.sapportals.wcm.WcmException,
                           IOException

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

Throws:: ResourceException; com.sapportals.wcm.WcmException; IOException

indexDocuments

public void indexDocuments(IResourceList resources,
                           String taxonomyName,
                           com.sapportals.wcm.util.uri.IRidList taxonomyClasses,
                           boolean isSearchRelevant)
                    throws ResourceException,
                           com.sapportals.wcm.WcmException,
                           IOException

Indexes a list of documents (method for internal use)

Parameters:: resources - resources to index; taxonomyName - name of the taxonomy where the taxonomy classes have to be indexed with the document; taxonomyClasses - axonomy classes to index with the documents; isSearchRelevant - if true the documents can be found in a search if false the document is only for the training of the taxonomy classes
Throws:: ResourceException - Exception raised in failure situation; com.sapportals.wcm.WcmException - Exception raised in failure situation; IOException - Exception raised in failure situation

indexDocument

public void indexDocument(IResource resource,
                          String taxonomyName,
                          com.sapportals.wcm.util.uri.IUriList taxonomyClasses,
                          boolean isSearchRelevant)
                   throws ResourceException,
                          com.sapportals.wcm.WcmException,
                          IOException

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

Throws:: ResourceException; com.sapportals.wcm.WcmException; IOException

indexDocuments

public void indexDocuments(IResourceList resources)
                    throws ResourceException,
                           com.sapportals.wcm.WcmException,
                           IOException

Indexes a list of documents

Specified by:: indexDocuments in interface IIndex
Overrides:: indexDocuments in class AbstractIndex

Parameters:: resources - resources to index; reindexMode - true if the documents are indexed via the reindex call; sendLinkEvents - if true create link event will be send for classification results
Throws:: ResourceException - Exception raised in failure situation; com.sapportals.wcm.WcmException - Exception raised in failure situation; IOException - Exception raised in failure situation

indexDocuments

public void indexDocuments(IResourceList resources,
                           boolean reindexMode,
                           boolean sendLinkEvents)
                    throws ResourceException,
                           com.sapportals.wcm.WcmException,
                           IOException

Indexes a list of documents

Parameters:: resources - resources to index; reindexMode - true if the documents are indexed via the reindex call; sendLinkEvents - if true create link event will be send for classification results
Throws:: ResourceException - Exception raised in failure situation; com.sapportals.wcm.WcmException - Exception raised in failure situation; IOException - Exception raised in failure situation

indexDocument

public void indexDocument(IResource resource,
                          String taxonomyName,
                          com.sapportals.wcm.util.uri.IRidList taxonomyClasses,
                          boolean isSearchRelevant)
                   throws ResourceException,
                          com.sapportals.wcm.WcmException,
                          IOException

indexes a document (method for internal use)

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 the training of the taxonomy classes
Throws:: ResourceException - Exception raised in failure situation; com.sapportals.wcm.WcmException - Exception raised in failure situation; IOException - Exception raised in failure situation

classifyDocuments

public Collection classifyDocuments(IResourceList resourceDocuments,
                                    String taxonomyName,
                                    int maxResults)
                             throws com.sapportals.wcm.WcmException

Classifies documents (which taxonomy class folders do the documents fit best)

Parameters:: resourceDocuments - Resource list of documents you want to classify; maxResults - maximum number of returned taxonomy classes; taxonomyName - name of the taxonomy where
Returns:: Collection of IClassificationResult
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

classifyDocuments

public Collection classifyDocuments(IResourceList resourceDocuments,
                                    String taxonomyName)
                             throws com.sapportals.wcm.WcmException

Classifies documents (which taxonomy class folders do the documents fit best)

Parameters:: resourceDocuments - Resource list of documents you want to classify; taxonomyName - name of the taxonomy for that classification proposals have to be found
Returns:: Collection of IClassificationResult
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

unfilteredClassifyDocuments

public Collection unfilteredClassifyDocuments(IResourceList resourceDocuments,
                                              String taxonomyName,
                                              float threshold,
                                              int maxResults)
                                       throws com.sapportals.wcm.WcmException

Classifies documents (which taxonomy class folders do the documents fit best)

Parameters:: resourceDocuments - Resource list of documents you want to classify; threshold - lowest rank value of a returned taxonomy class; maxResults - maximum number of returned taxonomy classes; taxonomyName - name of the taxonomy for that classification proposals have to be found
Returns:: Collection of IClassificationResult
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

unfilteredClassifyDocuments

public Map unfilteredClassifyDocuments(IResource resource,
                                       List taxonomies,
                                       float threshold,
                                       int maxResults)
                                throws com.sapportals.wcm.WcmException

Classifies document according several taxonomies (which taxonomy class folders do the document fit best)

Parameters:: resource - Resource you want to classify; taxonomies - name of the taxonomies for which classification proposals have to be found; threshold - lowest rank value of a returned taxonomy class; maxResults - maximum number of returned taxonomy classes
Returns:: Collection of IClassificationResult
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

classifyDocuments

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

Classifies documents (which taxonomy class folders do the documents fit best).
If a document is already classified with the proposed class, the class is not returned. To get also these classes use unfilteredClassifyDocuments.

Parameters:: resourceDocuments - Resource list of documents you want to classify; threshold - lowest rank value of a returned taxonomy class; maxResults - maximum number of returned taxonomy classes; taxonomyName - name of the taxonomy for that classification proposals have to be found
Returns:: Collection of IClassificationResult
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

classifyDocuments

public Collection classifyDocuments(IResourceList resourceDocuments,
                                    String taxonomyName,
                                    float threshold,
                                    int maxResults,
                                    boolean checkIfInIndex)
                             throws com.sapportals.wcm.WcmException

Parameters:: resourceDocuments - Resource list of documents you want to classify; threshold - lowest rank value of a returned taxonomy class; maxResults - maximum number of returned taxonomy classes; taxonomyName - name of the taxonomy for that classification proposals have to be found; checkIfInIndex - if true it is checked if the current version of the document is already in the index; then the document has not to be preprocessed again
Returns:: Collection of IClassificationResult
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

internalClassifyDocuments

protected Collection internalClassifyDocuments(IResourceList resourceDocuments,
                                               String taxonomyName,
                                               float threshold,
                                               int maxResults)
                                        throws com.sapportals.wcm.WcmException

Classifies documents (which taxonomy class folders do the documents fit best)

Parameters:: resourceDocuments - Resource list of documents you want to classify; threshold - lowest rank value of a returned taxonomy class; maxResults - maximum number of returned taxonomy classes; taxonomyName - name of the taxonomy for that classification proposals have to be found
Returns:: Collection of IClassificationResult
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

internalClassifyDocuments

protected Collection internalClassifyDocuments(IResourceList resourceDocuments,
                                               String taxonomyName,
                                               float threshold,
                                               int maxResults,
                                               boolean checkIfInIndex)
                                        throws com.sapportals.wcm.WcmException

Classifies documents (which taxonomy class folders do the documents fit best). If this method is not overwritten by the particular classification index it only delegates the call to the old method without checkIfInIndex. This is for compatibility reasons.

Parameters:: resourceDocuments - Resource list of documents you want to classify; threshold - lowest rank value of a returned taxonomy class; maxResults - maximum number of returned taxonomy classes; taxonomyName - name of the taxonomy for that classification proposals have to be found; checkIfInIndex - if true it is checked if the current version of the document is already in the index; then the document has not to be preprocessed again
Returns:: Collection of IClassificationResult
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

internalClassifyDocuments

protected Map internalClassifyDocuments(IResource resource,
                                        List taxonomies,
                                        float threshold,
                                        int maxResults)
                                 throws com.sapportals.wcm.WcmException

Throws:: com.sapportals.wcm.WcmException

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

internalIndexDocuments

protected abstract void internalIndexDocuments(IResourceList resources,
                                               String taxonomyName,
                                               com.sapportals.wcm.util.uri.IRidList taxonomyClasses,
                                               IResourceEvent resourceEvent,
                                               boolean isSearchRelevant,
                                               boolean reindexMode,
                                               boolean sendLinkEvents)
                                        throws ResourceException,
                                               com.sapportals.wcm.WcmException,
                                               IOException

Indexes a list of documents (method for internal use)

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 the training of the taxonomy classes
Throws:: ResourceException - Exception raised in failure situation; com.sapportals.wcm.WcmException - Exception raised in failure situation; IOException - Exception raised in failure situation

internalIndexDocuments

protected void internalIndexDocuments(IResourceList resources,
                                      IResourceEvent resourceEvent)
                               throws ResourceException,
                                      com.sapportals.wcm.WcmException,
                                      IOException

indexes a list of documents (method for internal use)

Overrides:: internalIndexDocuments in class AbstractIndex

Parameters:: resources - list of resources to index; resourceEvent - event that caused the index request
Throws:: ResourceException - Exception raised in failure situation; com.sapportals.wcm.WcmException - Exception raised in failure situation; IOException - Exception raised in failure situation

indexDocumentClassification

protected abstract void indexDocumentClassification(IResource document,
                                                    IIndexService indexService)

Parameters:: document - document that has to be indexes; indexService - index service from the service factory

finishXPostClear

public void finishXPostClear()
                      throws com.sapportals.wcm.WcmException

Only for internal usage.

Throws:: com.sapportals.wcm.WcmException

reindexTrainingResources

protected boolean reindexTrainingResources(IIndexFolderList preClearIndexFolders)
                                    throws com.sapportals.wcm.WcmException

Only for internal usage.

Parameters:: preClearIndexFolders -
Returns:
Throws:: com.sapportals.wcm.WcmException

indexManualTrainDocs

public void indexManualTrainDocs()
                          throws com.sapportals.wcm.WcmException

Only for internal usage.

Throws:: com.sapportals.wcm.WcmException

getDocumentClassificationStatus

public ClassificationStatus getDocumentClassificationStatus(IResource document,
                                                            String taxonomyName)
                                                     throws com.sapportals.wcm.WcmException

Deprecated. use new enums package for jdk 1.5 compatibility

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:: com.sapportals.wcm.WcmException

getDocumentClassificationStatusNewEnum

public ClassificationStatus getDocumentClassificationStatusNewEnum(IResource document,
                                                                   String taxonomyName)
                                                            throws com.sapportals.wcm.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:: com.sapportals.wcm.WcmException

setOnlyAppPropertyDocClassificationStatus

public void setOnlyAppPropertyDocClassificationStatus(IResource document,
                                                      String taxonomyName,
                                                      ClassificationStatus status)
                                               throws com.sapportals.wcm.WcmException

Only for internal usage.

Parameters:: document -; taxonomyName -; status -
Throws:: com.sapportals.wcm.WcmException

addOnlyAppPropManAssigned

public void addOnlyAppPropManAssigned(IResource document,
                                      com.sapportals.wcm.util.uri.RID category)
                               throws com.sapportals.wcm.WcmException

Only for internal usage.

Parameters:: document -; category -
Throws:: com.sapportals.wcm.WcmException

addOnlyAppPropManDeclassified

public void addOnlyAppPropManDeclassified(IResource document,
                                          com.sapportals.wcm.util.uri.RID category)
                                   throws com.sapportals.wcm.WcmException

Only for internal usage.

Parameters:: document -; category -
Throws:: com.sapportals.wcm.WcmException

setDocumentClassificationStatus

public void setDocumentClassificationStatus(IResource document,
                                            String taxonomyName,
                                            ClassificationStatus status)
                                     throws com.sapportals.wcm.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; the - documents classification status in the taxonomy
Throws:: com.sapportals.wcm.WcmException

setDocumentClassificationStatus

public void setDocumentClassificationStatus(IResource document,
                                            String taxonomyName,
                                            ClassificationStatus status,
                                            String notToSend)
                                     throws com.sapportals.wcm.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; the - documents classification status in the taxonomy; notToSend - String describing an event, which should be suppressed
Throws:: com.sapportals.wcm.WcmException

setDocumentClassificationStatus

public void setDocumentClassificationStatus(IResource document,
                                            String taxonomyName,
                                            ClassificationStatus status,
                                            boolean sendEvents,
                                            String notToSend)
                                     throws com.sapportals.wcm.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; status - the documents classification status in the taxonomy; sendEvents - only send events if true; notToSend - String describing an event, which should be suppressed
Throws:: com.sapportals.wcm.WcmException

setDocumentClassificationStatus

public void setDocumentClassificationStatus(IResourceList documents,
                                            String taxonomyName,
                                            ClassificationStatus status)
                                     throws com.sapportals.wcm.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; the - documents classification status in the taxonomy
Throws:: com.sapportals.wcm.WcmException

getDocumentsToClassify

public IResourceList getDocumentsToClassify(String taxonomyName)
                                     throws com.sapportals.wcm.WcmException

Deprecated. as of NW04.

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

Parameters:: taxonomyName - name of the taxonomy for that the documents that are to classify should be returned
Returns:: list of resources that are the documents to classify for the given taxonomy
Throws:: com.sapportals.wcm.WcmException

getDocumentsToClassify

public IResourceList getDocumentsToClassify(String taxonomyName,
                                            IResourceContext context)
                                     throws com.sapportals.wcm.WcmException

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

Parameters:: taxonomyName - name of the taxonomy for that 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:: com.sapportals.wcm.WcmException

getDocumentsNeverToClassify

public IResourceList getDocumentsNeverToClassify(String taxonomyName,
                                                 IResourceContext context)
                                          throws com.sapportals.wcm.WcmException

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

Parameters:: taxonomyName - name of the taxonomy for that the documents that are never to be classified should be returned; context - user context
Returns:: list of resources that are the documents "never to be classified" for the given taxonomy
Throws:: com.sapportals.wcm.WcmException

getDocumentsNeverToClassify

public IResourceList getDocumentsNeverToClassify(String taxonomyName)
                                          throws com.sapportals.wcm.WcmException

Deprecated. as of NW04.

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

Parameters:: taxonomyName - name of the taxonomy for that the documents that are never to be classified should be returned
Returns:: list of resources that are the document never to be classified for the given taxonomy
Throws:: com.sapportals.wcm.WcmException

getDocumentRidsToClassify

public com.sapportals.wcm.util.uri.IRidList getDocumentRidsToClassify(String taxonomyName,
                                                                      IResourceContext context)
                                                               throws com.sapportals.wcm.WcmException

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

Parameters:: taxonomyName - name of the taxonomy for that the documents that are to classify should be returned; context - user context
Returns:: list of rids that are the documents "to classify" for the given taxonomy
Throws:: com.sapportals.wcm.WcmException

getDocumentRidsNeverToClassify

public com.sapportals.wcm.util.uri.IRidList getDocumentRidsNeverToClassify(String taxonomyName,
                                                                           IResourceContext context)
                                                                    throws com.sapportals.wcm.WcmException

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

Parameters:: taxonomyName - name of the taxonomy for that the documents that are never to be classified should be returned; context - user context
Returns:: list of rids that are the documents "never to be classified" for the given taxonomy
Throws:: com.sapportals.wcm.WcmException

getSpecialFolderRID

public com.sapportals.wcm.util.uri.RID getSpecialFolderRID(String taxonomyName,
                                                           SpecialFolder specialFolderType)
                                                    throws com.sapportals.wcm.WcmException

Parameters:: taxonomyName - name of the taxonomy; specialFolderType - type of special folder
Returns:: rid of special folder within the taxonomy manager
Throws:: com.sapportals.wcm.WcmException

getDocClassification

public IDocClassificationMap getDocClassification(IResource document)
                                           throws com.sapportals.wcm.WcmException

Gets the classification that has been set for the document. This call has nothing to do with classify documents. It only gives the document classes set by setDocClassification(). It returns only classes for which the user in the resource context if the input document has read access.

Parameters:: document - document for that the classification has to be returned
Returns:: IDocClassificationMap with classifications per taxonomy name
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

getDocClassification

public IDocClassificationMap getDocClassification(IResource document,
                                                  IResourceContext context)
                                           throws com.sapportals.wcm.WcmException

Gets the classification that has been set for the document. This call has nothing to do with classify documents. It only gives the document classes set by setDocClassification(). It returns only classes for which the user in the context has read access. If the context parameter is null the contect of the input document is used.

Parameters:: document - document for that the classification has to be returned; context -
Returns:: IDocClassificationMap with classifications per taxonomy name
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

getDocListClassification

public IDocClassificationMapList getDocListClassification(IResourceList documents)
                                                   throws com.sapportals.wcm.WcmException

Gets the classifications that have been set for the documents. Only classes for which the context in the documents has read access will be returned.

Parameters:: documents - list of documents for that the classification has to be returned
Returns:: IDocClassificationMapList that contains an IDocClassificationMap for every document
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation.

getDocListClassification

public IDocClassificationMapList getDocListClassification(IResourceList documents,
                                                          IResourceContext context)
                                                   throws com.sapportals.wcm.WcmException

Gets the classifications that have been set for the documents. Only classes for which the user of the context parameter has read access will be returned. If context is null the context of the input resources is used.

Parameters:: documents - list of documents for that the classification has to be returned; context -
Returns:: IDocClassificationMapList that contains an IDocClassificationMap for every document
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation.

setDocClassification

public void setDocClassification(IDocClassificationMap documentClassificationMap)
                          throws com.sapportals.wcm.WcmException

Stores the document classification that has been choosen by manual or automatic classification.

Parameters:: documentClassificationMap - container with the document and its classification for all taxonomies
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

setDocClassification

public void setDocClassification(IDocClassificationMap documentClassificationMap,
                                 String notToSend)
                          throws com.sapportals.wcm.WcmException

Stores the document classification that has been choosen by manual or automatic classification.

Parameters:: documentClassificationMap - container with the document and its classification for all taxonomies; notToSend - String describing an event, which should be suppressed
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

setDocClassification

public void setDocClassification(IDocClassificationMap documentClassificationMap,
                                 boolean indexDocumentClassification)
                          throws com.sapportals.wcm.WcmException

Stores the document classification that has been choosen 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 document is indexed imediately before or after the call by another routine.
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

setDocClassification

public void setDocClassification(IDocClassificationMap documentClassificationMap,
                                 boolean indexDocumentClassification,
                                 boolean isTrainingDocument)
                          throws com.sapportals.wcm.WcmException

Stores the document classification that has been choosen 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 document is indexed imediately before or after the call by another routine.; isTrainingDocument - if true the classification is is indexed to train the index
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

setDocClassification

public void setDocClassification(IDocClassificationMap documentClassificationMap,
                                 boolean indexDocumentClassification,
                                 boolean isTrainingDocument,
                                 boolean sendLinkEvents)
                          throws com.sapportals.wcm.WcmException

Stores the document classification that has been choosen 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 document is indexed imediately before or after the call by another routine.; isTrainingDocument - if true the classification is is indexed to train the index; sendLinkEvents - if true create link event will be send
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

setDocClassification

public void setDocClassification(IDocClassificationMap documentClassificationMap,
                                 boolean indexDocumentClassification,
                                 boolean isTrainingDocument,
                                 boolean sendLinkEvents,
                                 String notToSend)
                          throws com.sapportals.wcm.WcmException

Stores the document classification that has been choosen 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 document is indexed imediately before or after the call by another routine.; isTrainingDocument - if true the classification is is indexed to train the index; sendLinkEvents - if true create link event will be send; notToSend - String describing an event, which should be suppressed
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

getClassesStringList

public List getClassesStringList(IDocClassificationMap documentClassification)

List of strings representing the classes in the parameter.

Parameters:: documentClassification -
Returns:

setDocListClassification

public void setDocListClassification(IDocClassificationMapList documentClassificationMapList)
                              throws com.sapportals.wcm.WcmException

Stores the documents classifications that has been choosen by manual or automatic classification.

Parameters:: documentClassificationMapList - list of containers with the document and its classification for all taxonomies
Throws:: com.sapportals.wcm.WcmException - Exception raised in failure situation

setTaxonomyType

public void setTaxonomyType(String taxonomyName,
                            TaxonomyType taxonomyType)
                     throws com.sapportals.wcm.WcmException

Deprecated. use new enums package for jdk 1.5 compatibility

Sets the type for the taxonomy

Parameters:: taxonomyName - name of the taxonomy; taxonomyType - new taxonomy type
Throws:: com.sapportals.wcm.WcmException

setIndexOnlyClassifiedDocs

public void setIndexOnlyClassifiedDocs(boolean indexOnlyClassifiedDocs)
                                throws com.sapportals.wcm.WcmException

If set on true, only documents are indexed, which are also assigned to categories, otherwise all documents are indexed.

Parameters:: indexOnlyClassifiedDocs -
Throws:: com.sapportals.wcm.WcmException

getTaxonomyType

public TaxonomyType getTaxonomyType(String taxonomyName)
                             throws com.sapportals.wcm.WcmException

Deprecated. use new enums package for jdk 1.5 compatibility

Parameters:: taxonomyName - the name of the taxonomy
Returns:: the taxonomy type
Throws:: com.sapportals.wcm.WcmException

getTaxonomyTypeNewEnum

public TaxonomyType getTaxonomyTypeNewEnum(String taxonomyName)
                                    throws com.sapportals.wcm.WcmException

Parameters:: taxonomyName - the name of the taxonomy
Returns:: the taxonomy type
Throws:: com.sapportals.wcm.WcmException

isIndexOnlyClassifiedDocs

public boolean isIndexOnlyClassifiedDocs()
                                  throws com.sapportals.wcm.WcmException

Returns true, if only documents are indexed, which could be assigned to categories. Otherwise false is returned.

Returns:: true or false
Throws:: com.sapportals.wcm.WcmException

getQueryFolder

public IQueryFolder getQueryFolder(com.sapportals.wcm.util.uri.RID taxonomyClassRid)
                            throws com.sapportals.wcm.WcmException

Gets a query folder instance

Parameters:: taxonomyClassRid - rid of the taxonomy class that is the query folder
Returns:: the query folder instance
Throws:: com.sapportals.wcm.WcmException

getDocumentTrainingClasses

public com.sapportals.wcm.util.uri.IRidList getDocumentTrainingClasses(IResource document)
                                                                throws com.sapportals.wcm.WcmException

Parameters:: document - document for that the training classes have to be returned
Returns:: rid list of taxonomy classes for that the document is a training document
Throws:: com.sapportals.wcm.WcmException

getManuallyDeclassifiedClasses

public com.sapportals.wcm.util.uri.IRidList getManuallyDeclassifiedClasses(IResource document)
                                                                    throws com.sapportals.wcm.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:: com.sapportals.wcm.WcmException

autoClassifyDocs

public void autoClassifyDocs(String taxonomyName,
                             com.sapportals.wcm.util.uri.IRidList docRidList,
                             IResourceContext context)
                      throws com.sapportals.wcm.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:: com.sapportals.wcm.WcmException

autoClassifyDocs

public void autoClassifyDocs(String taxonomyName,
                             IResourceList docList,
                             IResourceContext context)
                      throws com.sapportals.wcm.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 of documents of a taxonomy to be reclassified; context - user context
Throws:: com.sapportals.wcm.WcmException

autoClassifyDocs

public void autoClassifyDocs(String taxonomyName,
                             IResourceContext context)
                      throws com.sapportals.wcm.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:: com.sapportals.wcm.WcmException

deleteTaxRmIndexFolder

protected void deleteTaxRmIndexFolder(IResourceContext context)
                               throws com.sapportals.wcm.WcmException

Deletes the whole folder hierarchy of an index in the taxonomy repository. This method has to be called in the delete method of any class that is implementing IClassificationIndex.

Throws:: com.sapportals.wcm.WcmException

createTaxRmIndexFolder

protected ICollection createTaxRmIndexFolder(IResourceContext context)
                                      throws com.sapportals.wcm.WcmException

Creates the folder that represents the index in the taxonomy repository. If taxonomy names have been added to the index, taxonomy folders are created as children of the index folder. This method has to be called in the generate method of any class that is implementing IClassificationIndex.

Throws:: com.sapportals.wcm.WcmException

removeCategoryAssignments

public void removeCategoryAssignments(ICollection deletedCategoryFolder)
                               throws com.sapportals.wcm.WcmException

Removes the assignment of all documents of the index to a category.

Parameters:: deletedTaxClassFolder - category that has been deleted
Throws:: com.sapportals.wcm.WcmException

deleteIndexTaxDocClassification

public void deleteIndexTaxDocClassification(com.sapportals.wcm.util.uri.IRidList documentIDs)
                                     throws com.sapportals.wcm.WcmException

Deletes the classification of the documents regarding the taxonomies of this index.

Parameters:: documentIDs - documents for that the classification has to be removed
Throws:: com.sapportals.wcm.WcmException

getPropertyNameTaxonomy

protected IPropertyName getPropertyNameTaxonomy(String taxonomyName)
                                         throws com.sapportals.wcm.WcmException

Returns:: property name to get document classification from the application properties
Throws:: com.sapportals.wcm.WcmException

getPropertyNameTrainingClasses

public static IPropertyName getPropertyNameTrainingClasses()
                                                    throws com.sapportals.wcm.WcmException

Returns:
Throws:: com.sapportals.wcm.WcmException

getPropertyNameManuallyDeclassifiedClasses

public static IPropertyName getPropertyNameManuallyDeclassifiedClasses()
                                                                throws com.sapportals.wcm.WcmException

Returns:
Throws:: com.sapportals.wcm.WcmException

getClassTrainingDocuments

public com.sapportals.wcm.util.uri.IRidList getClassTrainingDocuments(com.sapportals.wcm.util.uri.RID categoryRid,
                                                                      IResourceContext context)
                                                               throws com.sapportals.wcm.WcmException

Returns the training documents of a category.

Parameters:: categoryRid -; context -
Returns:
Throws:: com.sapportals.wcm.WcmException

getClassTrainingDocuments

public com.sapportals.wcm.util.uri.IRidList getClassTrainingDocuments(com.sapportals.wcm.util.uri.RID categoryRid,
                                                                      IResourceContext context,
                                                                      IApplicationProperties appPropService)
                                                               throws com.sapportals.wcm.WcmException

Returns the training documents of a category.

Parameters:: categoryRid -; context -; appPropService -
Returns:
Throws:: com.sapportals.wcm.WcmException

getClassDeclassifiedDocuments

public com.sapportals.wcm.util.uri.IRidList getClassDeclassifiedDocuments(com.sapportals.wcm.util.uri.RID categoryRid,
                                                                          IResourceContext context)
                                                                   throws com.sapportals.wcm.WcmException

Returns the manyually declassified resourced for the category.

Parameters:: categoryRid -; context -
Returns:
Throws:: com.sapportals.wcm.WcmException

getClassDeclassifiedDocuments

public com.sapportals.wcm.util.uri.IRidList getClassDeclassifiedDocuments(com.sapportals.wcm.util.uri.RID categoryRid,
                                                                          IResourceContext context,
                                                                          IApplicationProperties appPropService)
                                                                   throws com.sapportals.wcm.WcmException

Returns the manyually declassified resourced for the category.

Parameters:: categoryRid -; context -; appPropService -
Returns:
Throws:: com.sapportals.wcm.WcmException

updateCategoryContents

public abstract void updateCategoryContents(String taxonomyName,
                                            boolean dirtyOnly,
                                            IResourceContext context)
                                     throws com.sapportals.wcm.WcmException

Starts a process that checks and updates categories of a taxonomy where the query is not in sync with the documents of category.

Parameters:: taxonomyName - name of the taxonomy to check; dirtyOnly - if false all categories are checked, if false only categories that are out of sync (dirty) are updated.; context - user context
Throws:: com.sapportals.wcm.WcmException

addResourceToClassificationIndex

protected void addResourceToClassificationIndex(com.sapportals.wcm.util.uri.RID resourceRID,
                                                IResourceContext context)
                                         throws com.sapportals.wcm.WcmException

Adds a resource to the list of resources that are index in the index.

Parameters:: resourceRID - ID of the resource to add; context - user context
Throws:: com.sapportals.wcm.WcmException

removeResourceFromClassificationIndex

protected void removeResourceFromClassificationIndex(com.sapportals.wcm.util.uri.RID resourceRID,
                                                     IResourceContext context)
                                              throws com.sapportals.wcm.WcmException

Removes a resource from the list of resources that are indexed in the index.

Parameters:: resourceRID - ID of the resource to remove; context - user context
Throws:: com.sapportals.wcm.WcmException

synchronizeTaxonomyMetaData

public void synchronizeTaxonomyMetaData(String taxonomyName)
                                 throws com.sapportals.wcm.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:: com.sapportals.wcm.WcmException

deleteClassificationProperties

public void deleteClassificationProperties(IResource resource)
                                    throws com.sapportals.wcm.WcmException

Deletes all classification properties of a document; used to delete properties of old versions Only for internal usage

Parameters:: resource -
Throws:: com.sapportals.wcm.WcmException

getAllCollections

public static void getAllCollections(ICollection col,
                                     IResourceList resources)

Coolects all collections below col in resources.

Parameters:: dataSearchFromHereResource -

getUpdateTaxonomyState

public UpdateTaxonomyState getUpdateTaxonomyState(String taxonomyName)
                                           throws com.sapportals.wcm.WcmException

Returns the status of the taxonomy with respect to an update operation.

Parameters:: taxonomyName -
Returns:
Throws:: com.sapportals.wcm.WcmException

getUpdateTaxonomyState

public UpdateTaxonomyState getUpdateTaxonomyState(String taxonomyName,
                                                  Locale locale)
                                           throws com.sapportals.wcm.WcmException

Returns the status of the taxonomy with respect to an update operation.

Parameters:: taxonomyName -; locale -
Returns:
Throws:: com.sapportals.wcm.WcmException

setUpdateTaxonomyState

public void setUpdateTaxonomyState(String state,
                                   String taxonomyName,
                                   int visitedCategories,
                                   int catgoriesToUpdate,
                                   int allCategories)
                            throws com.sapportals.wcm.WcmException

only for internal usage

Parameters:: state -; taxonomyName -; visitedCategories -; catgoriesToUpdate -; allCategories -
Throws:: com.sapportals.wcm.WcmException

checkUpdateTaxonomyStateDuringStartUp

public void checkUpdateTaxonomyStateDuringStartUp()
                                           throws com.sapportals.wcm.WcmException

only for internal usage

Throws:: com.sapportals.wcm.WcmException

setQueryFolderExternalFast

public void setQueryFolderExternalFast(IQueryFolder queryFolder,
                                       IQueryEntryList query)
                                throws com.sapportals.wcm.WcmException

only for internal usage

Parameters:: queryFolder -; query -
Throws:: com.sapportals.wcm.WcmException

multiTaxonomyClassificationPossible

public boolean multiTaxonomyClassificationPossible()

Returns true if the index support classification calls for more than one taxonomy

Returns:

getDocumentTaxRMRids

public static Map getDocumentTaxRMRids(com.sapportals.wcm.util.uri.RID taxonomyClassRid,
                                       IResourceList documents)
                                throws com.sapportals.wcm.WcmException

only for internal usage

Returns:: Map: Document RID -> Taxonomy RM RID
Throws:: com.sapportals.wcm.WcmException

getDocumentTaxRMRid

public static com.sapportals.wcm.util.uri.RID getDocumentTaxRMRid(com.sapportals.wcm.util.uri.RID taxonomyClassRid,
                                                                  com.sapportals.wcm.util.uri.RID documentRid)
                                                           throws com.sapportals.wcm.WcmException

only for internal usage

Parameters:: taxonomyClassRid -; documentRid -
Returns:
Throws:: com.sapportals.wcm.WcmException

makeDocTaxRmRid

public static com.sapportals.wcm.util.uri.RID makeDocTaxRmRid(com.sapportals.wcm.util.uri.RID taxonomyClassRid,
                                                              com.sapportals.wcm.util.uri.RID documentRid,
                                                              String docGuid)

only for internal usage

Parameters:: taxonomyClassRid -; documentRid -; docGuid -
Returns:

getDocumentReplaceName

public static com.sapportals.wcm.util.uri.RID getDocumentReplaceName(com.sapportals.wcm.util.uri.RID documentRid)
                                                              throws com.sapportals.wcm.WcmException

only for internal usage

Parameters:: documentRid -
Returns:
Throws:: com.sapportals.wcm.WcmException

getTargetRIDFromReplaceName

public static com.sapportals.wcm.util.uri.RID getTargetRIDFromReplaceName(com.sapportals.wcm.util.uri.RID linkRid)
                                                                   throws com.sapportals.wcm.WcmException

only for internal usage

Parameters:: linkRid -
Returns:
Throws:: com.sapportals.wcm.WcmException

getRIDFromConstantID

public static com.sapportals.wcm.util.uri.RID getRIDFromConstantID(String guid)
                                                            throws com.sapportals.wcm.WcmException

only for internal usage

Parameters:: guid -
Returns:
Throws:: com.sapportals.wcm.WcmException

clearGuidCache

public static void clearGuidCache()

only for internal usage

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
`[sap.com] KMC-CM`	`[sap.com] tc/km/frwk`	`api`	`EP-KM-CM`
`[sap.com] KMC-WPC`	`[sap.com] tc/kmc/wpc/wpcfacade`	`api`	`EP-PIN-WPC-WCM`

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

SAP NetWeaver 7.30 SP01 KMC

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD