public abstract class AbstractClassificationIndex extends AbstractIndex
AbstractClassificationIndex
offers classification functionality, which is independent from the index implementation.
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)
AbstractIndex.ErrorState, AbstractIndex.IndexingState, AbstractIndex.Reindexer, AbstractIndex.ReindexerWithoutClear, AbstractIndex.RunningState, AbstractIndex.WhatToIndex
Modifier and Type | Field and Description |
---|---|
protected Map |
m_inboxFiller |
protected static String |
m_taxonomyRmPrefix |
protected static boolean |
m_useBestClasses |
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 and Description |
---|
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) |
Modifier and Type | Method and Description |
---|---|
void |
addOnlyAppPropManAssigned(IResource document,
RID category)
Only for internal usage.
|
void |
addOnlyAppPropManDeclassified(IResource document,
RID category)
Only for internal usage.
|
protected void |
addResourceToClassificationIndex(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,
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(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)
Collects 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.
|
IRidList |
getClassDeclassifiedDocuments(RID categoryRid,
IResourceContext context) |
IRidList |
getClassDeclassifiedDocuments(RID categoryRid,
IResourceContext context,
IApplicationProperties appPropService) |
IRidList |
getClassDocumentRids(ICollection taxonomyClass)
Gets the resource IDs of all documents of a taxonomy class
|
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.
|
IRidList |
getClassDocumentRids(RID taxonomyClassRid,
IResourceContext context)
Gets the resource IDs of all documents of a taxonomy class
|
IRidList |
getClassDocumentRids(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(RID taxonomyClassRid,
IResourceContext context)
Gets all documents of a taxonomy class
|
List |
getClassesStringList(IDocClassificationMap documentClassification)
List of strings representing the classes in the parameter.
|
IRidList |
getClassTrainingDocuments(RID categoryRid,
IResourceContext context) |
IRidList |
getClassTrainingDocuments(RID categoryRid,
IResourceContext context,
IApplicationProperties appPropService) |
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 RID |
getDocumentReplaceName(RID documentRid)
only for internal usage
|
IRidList |
getDocumentRidsNeverToClassify(String taxonomyName,
IResourceContext context)
Gets all rids of documents of an index that have the status "never to classify" within a taxonomy
|
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 RID |
getDocumentTaxRMRid(RID taxonomyClassRid,
RID documentRid)
only for internal usage
|
static Map |
getDocumentTaxRMRids(RID taxonomyClassRid,
IResourceList documents) |
IRidList |
getDocumentTrainingClasses(IResource document) |
IRidList |
getManuallyDeclassifiedClasses(IResource document) |
static IPropertyName |
getPropertyNameManuallyDeclassifiedClasses() |
protected IPropertyName |
getPropertyNameTaxonomy(String taxonomyName) |
static IPropertyName |
getPropertyNameTrainingClasses() |
IQueryFolder |
getQueryFolder(RID taxonomyClassRid)
Gets a query folder instance
|
static RID |
getRIDFromConstantID(String guid)
only for internal usage
|
RID |
getSpecialFolderRID(String taxonomyName,
SpecialFolder specialFolderType) |
static RID |
getTargetRIDFromReplaceName(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) |
float |
getTaxonomyClassificationThreshold(String taxonomyName,
String thresholdId)
Gets the threshold of a taxonomy
|
String |
getTaxonomyRmPrefix()
Get the TaxonomyRmPrefix attribute of the AbstractClassificationIndex object.
|
RID |
getTaxonomyTrainingRid(String taxonomyName)
Gets the uri of the root folder of the hierarchy that has been used to train/create the given taxonomy.
|
URI |
getTaxonomyTrainingUri(String taxonomyName)
Deprecated.
as of NW04. Use getTaxonomyTrainingRid(String)
|
TaxonomyType |
getTaxonomyType(String taxonomyName)
Deprecated.
use new enums package for jdk 1.5 compatibility
|
TaxonomyType |
getTaxonomyTypeNewEnum(String taxonomyName) |
UpdateTaxonomyState |
getUpdateTaxonomyState(String taxonomyName) |
UpdateTaxonomyState |
getUpdateTaxonomyState(String taxonomyName,
Locale locale) |
boolean |
hasTaxonomy(String name) |
void |
indexDocument(IResource resource,
String taxonomyName,
IRidList taxonomyClasses,
boolean isSearchRelevant)
indexes a document (method for internal use)
|
void |
indexDocument(IResource resource,
String taxonomyName,
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,
IRidList taxonomyClasses,
boolean isSearchRelevant)
Indexes a list of documents (method for internal use)
|
void |
indexDocuments(IResourceList resources,
String taxonomyName,
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,
IRidList taxonomyClasses,
IResourceEvent resourceEvent,
boolean isSearchRelevant,
boolean reindexMode,
boolean sendLinkEvents)
Indexes a list of documents (method for internal use)
|
boolean |
isDocClassifiedInAnyTax(IResource resource) |
boolean |
isIndexOnlyClassifiedDocs()
Returns true, if only documents are indexed, which could be assigned to categories.
|
boolean |
isManuallyDeclassifiedDocument(IResource document,
RID taxonomyClassRid) |
boolean |
isTrainingDocument(IResource document,
RID taxonomyClassRid) |
static RID |
makeDocTaxRmRid(RID taxonomyClassRid,
RID documentRid,
String docGuid)
only for internal usage
|
boolean |
multiTaxonomyClassificationPossible() |
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(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 chosen by manual or automatic classification.
|
void |
setDocClassification(IDocClassificationMap documentClassificationMap,
boolean indexDocumentClassification)
Stores the document classification that has been chosen by manual or automatic classification.
|
void |
setDocClassification(IDocClassificationMap documentClassificationMap,
boolean indexDocumentClassification,
boolean isTrainingDocument)
Stores the document classification that has been chosen by manual or automatic classification.
|
void |
setDocClassification(IDocClassificationMap documentClassificationMap,
boolean indexDocumentClassification,
boolean isTrainingDocument,
boolean sendLinkEvents)
Stores the document classification that has been chosen by manual or automatic classification.
|
void |
setDocClassification(IDocClassificationMap documentClassificationMap,
boolean indexDocumentClassification,
boolean isTrainingDocument,
boolean sendLinkEvents,
String notToSend)
Stores the document classification that has been chosen by manual or automatic classification.
|
void |
setDocClassification(IDocClassificationMap documentClassificationMap,
String notToSend)
Stores the document classification that has been chosen 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,
RID trainingRid)
Set the TaxonomyTrainingUri attribute of the AbstractClassificationIndex object.
|
void |
setTaxonomyTrainingUri(String taxonomyName,
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() |
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, getQueryExtenders, 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
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
clear, delete, delete, generate, generate, getResourceInfo, getServiceTypes
protected static String m_taxonomyRmPrefix
protected static boolean m_useBestClasses
protected Map m_inboxFiller
public AbstractClassificationIndex(String indexId, String indexName, String indexGroup, IIndexFolderList indexFolders, String serviceId, String serviceUserId, Properties indexServiceProperties) throws WcmException
indexId
- index identifierindexName
- display name of the indexindexGroup
- the group the index has been assigned toserviceId
- the identifier of the index serviceserviceUserId
- id of the index management service user, to set the service contextindexServiceProperties
- config properties of the index management serviceindexFolders
- list of rids that are assigned to the indexWcmException
- Exception raised in failure situationpublic AbstractClassificationIndex(String indexId, String indexName, String indexGroup, IIndexFolderList indexFolders, String serviceId, String crawlerProfileId, String serviceUserId, Properties indexServiceProperties) throws WcmException
indexId
- index identifierindexName
- display name of the indexindexGroup
- the group the index has been assigned toserviceId
- the identifier of the index servicecrawlerProfileId
- - ID of the default crawler profile for all index folders of the indexserviceUserId
- id of the index management service user, to set the service contextindexServiceProperties
- config properties of the index management serviceindexFolders
- list of rids that are assigned to the indexWcmException
- Exception raised in failure situationpublic void setDocumentClassification(IResource document, Map classification) throws WcmException
document
- The new DocumentClassification valueclassification
- The new DocumentClassification valueWcmException
- Exception raised in failure situationpublic void setDocumentClassification(IResource document, Map classification, boolean indexDocumentClassification) throws WcmException
document
- The new DocumentClassification valueclassification
- The new DocumentClassification valueindexDocumentClassification
- The new DocumentClassification valueWcmException
- Exception raised in failure situationpublic void setDocumentClassification(IResource document, Map classification, boolean indexDocumentClassification, boolean isTrainingDocument) throws WcmException
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 immediately before or after the call by another routine.isTrainingDocument
- if true the added classes are indexed to train the indexWcmException
- Exception raised in failure situationpublic boolean isTrainingDocument(IResource document, RID taxonomyClassRid) throws WcmException
document
- the document to checktaxonomyClassRid
- 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.WcmException
- WcmExceptionpublic boolean isDocClassifiedInAnyTax(IResource resource) throws WcmException
resource
- resourceWcmException
- WcmExceptionpublic boolean isManuallyDeclassifiedDocument(IResource document, RID taxonomyClassRid) throws WcmException
document
- the document to checktaxonomyClassRid
- 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.WcmException
- WcmExceptionpublic void setTaxonomyClassificationThreshold(String taxonomyName, String thresholdId, float threshold) throws WcmException
taxonomyName
- The new TaxonomyClassificationThreshold valuethresholdId
- The new TaxonomyClassificationThreshold valuethreshold
- The new TaxonomyClassificationThreshold valueWcmException
- Exception raised in failure situationpublic void setTaxonomyTrainingUri(String taxonomyName, URI trainingUri) throws WcmException
taxonomyName
- The new TaxonomyTrainingUri valuetrainingUri
- The new TaxonomyTrainingUri valueWcmException
- Exception raised in failure situationpublic void setTaxonomyTrainingRid(String taxonomyName, RID trainingRid) throws WcmException
taxonomyName
- The new TaxonomyTrainingRid valuetrainingRid
- The new TaxonomyTrainingRid valueWcmException
- Exception raised in failure situationpublic void setTaxonomyBestClassesSensitivity(String taxonomyName, BestClassesSensitivity sensitivity) throws WcmException
taxonomyName
- name of the taxonomy (must exist for index)sensitivity
- The new TaxonomyBestClassesSensitivity valueWcmException
- Exception raised in failure situationpublic boolean hasTaxonomy(String name)
name
- namepublic List getTaxonomies()
public Map getDocumentClassification(IResource document) throws WcmException
document
- Document to get the classification forWcmException
- Exception raised in failure situationpublic float getTaxonomyClassificationThreshold(String taxonomyName, String thresholdId) throws WcmException
taxonomyName
- name of the taxonomy (must exist for index)thresholdId
- Constant IClassificationIndex.PROP_NAME_THRESHOLD_LEVEL1 or
IClassificationIndex.PROP_NAME_THRESHOLD_LEVEL2WcmException
- Exception raised in failure situationpublic URI getTaxonomyTrainingUri(String taxonomyName) throws WcmException
taxonomyName
- taxonomyNameWcmException
- WcmExceptionpublic RID getTaxonomyTrainingRid(String taxonomyName) throws WcmException
taxonomyName
- name of the taxonomy (must exist for index)WcmException
- Exception raised in failure situationpublic String getTaxonomyRmPrefix()
public IResourceList getClassDocuments(ICollection taxonomyClass) throws WcmException, ResourceException
taxonomyClass
- the taxonomy class folder you want to have documents forWcmException
- Exception raised in failure situationResourceException
- Exception raised in failure situationpublic IResourceList getClassDocuments(RID taxonomyClassRid, IResourceContext context) throws WcmException, ResourceException
taxonomyClassRid
- resource ID of the taxonomy class you want to have documents forcontext
- user contextWcmException
- Exception raised in failure situationResourceException
- Exception raised in failure situationpublic IRidList getClassDocumentRids(ICollection taxonomyClass) throws WcmException, ResourceException
taxonomyClass
- the taxonomy class folder you want to have documents forWcmException
- Exception raised in failure situationResourceException
- Exception raised in failure situationpublic IRidList getClassDocumentRids(ICollection taxonomyClass, List appPropServices) throws WcmException, ResourceException
taxonomyClass
- taxonomyClassappPropServices
- appPropServicesWcmException
- WcmExceptionResourceException
- ResourceExceptionpublic IRidList getClassDocumentRids(RID taxonomyClassRid, IResourceContext context) throws WcmException
taxonomyClassRid
- resource ID of the taxonomy class you want to have documents forcontext
- user contextWcmException
- Exception raised in failure situationResourceException
- Exception raised in failure situationpublic IRidList getClassDocumentRids(RID taxonomyClassRid, IResourceContext context, List appPropertyServices) throws WcmException
taxonomyClassRid
- taxonomyClassRidcontext
- contextappPropertyServices
- appPropertyServicesWcmException
- WcmExceptionpublic Collection getBestClassesOld(IResourceList resourceDocuments, String taxonomyName) throws WcmException
resourceDocuments
- Resource list of documents you want to classifytaxonomyName
- taxonomy for that the best classes have to be proposed forWcmException
- Exception raised in failure situationpublic Collection getBestClasses(IResourceList resourceDocuments, String taxonomyName) throws WcmException
resourceDocuments
- Resource list of documents you want to classifytaxonomyName
- taxonomy for that the best classes have to be proposed forWcmException
- Exception raised in failure situationpublic Collection getBestClasses(IResourceList resourceDocuments, String taxonomyName, int maxNumberOfDocs) throws WcmException
resourceDocuments
- Resource list of documents you want to classifytaxonomyName
- taxonomy for that the best classes have to be proposed formaxNumberOfDocs
- max number of results per documentWcmException
- Exception raised in failure situationpublic Collection getBestClasses(IResourceList resourceDocuments, String taxonomyName, Map thresholds) throws WcmException
resourceDocuments
- Resource list of documents you want to classifytaxonomyName
- taxonomy for that the best classes have to be proposed forthresholds
- class specific thresholdsWcmException
- Exception raised in failure situationpublic BestClassesSensitivity getTaxonomyBestClassesSensitivity(String taxonomyName) throws WcmException
taxonomyName
- name of the taxonomy (must exist for index)WcmException
- Exception raised in failure situationpublic float getTaxonomyBestClassesSensitivityValue(String taxonomyName) throws WcmException
taxonomyName
- taxonomyNameWcmException
- WcmExceptionpublic void initTaxonomies(List taxonomies)
taxonomies
- list of taxonomy namespublic void removeTaxonomy(String taxonomy)
removeTaxonomy(String,IResourceContext)
taxonomy
- name of the taxonomy to removepublic void removeTaxonomy(String taxonomy, IResourceContext context) throws WcmException
taxonomy
- name of the taxonomy to removecontext
- contextWcmException
- WcmExceptionpublic void addTaxonomy(String taxonomy) throws WcmException
addTaxonomy(String,IResourceContext)
taxonomy
- Taxonomy to be addedWcmException
- Exception raised in failure situationpublic void addTaxonomy(String taxonomy, IResourceContext context) throws WcmException
taxonomy
- Taxonomy to be addedcontext
- contextWcmException
- Exception raised in failure situationpublic void indexDocuments(IResourceList resources, String taxonomyName, IUriList taxonomyClasses, boolean isSearchRelevant) throws ResourceException, WcmException, IOException
resources
- resourcestaxonomyName
- taxonomyNametaxonomyClasses
- taxonomyClassesisSearchRelevant
- isSearchRelevantResourceException
- ResourceExceptionWcmException
- WcmExceptionIOException
- IOExceptionpublic void indexDocuments(IResourceList resources, String taxonomyName, IRidList taxonomyClasses, boolean isSearchRelevant) throws ResourceException, WcmException, IOException
resources
- resources to indextaxonomyName
- name of the taxonomy where the taxonomy classes have to be indexed with the documenttaxonomyClasses
- taxonomy classes to index with the documentsisSearchRelevant
- if true the documents can be found in a search if false the document is only for the training of the taxonomy classesResourceException
- Exception raised in failure situationWcmException
- Exception raised in failure situationIOException
- Exception raised in failure situationpublic void indexDocument(IResource resource, String taxonomyName, IUriList taxonomyClasses, boolean isSearchRelevant) throws ResourceException, WcmException, IOException
resource
- resourcetaxonomyName
- taxonomyNametaxonomyClasses
- taxonomyClassesisSearchRelevant
- isSearchRelevantResourceException
- ResourceExceptionWcmException
- WcmExceptionIOException
- IOExceptionpublic void indexDocuments(IResourceList resources) throws ResourceException, WcmException, IOException
indexDocuments
in interface IIndex
indexDocuments
in class AbstractIndex
resources
- resources to indexResourceException
- Exception raised in failure situationWcmException
- Exception raised in failure situationIOException
- Exception raised in failure situationpublic void indexDocuments(IResourceList resources, boolean reindexMode, boolean sendLinkEvents) throws ResourceException, WcmException, IOException
resources
- resources to indexreindexMode
- true if the documents are indexed via the reindex callsendLinkEvents
- if true create link event will be send for classification resultsResourceException
- Exception raised in failure situationWcmException
- Exception raised in failure situationIOException
- Exception raised in failure situationpublic void indexDocument(IResource resource, String taxonomyName, IRidList taxonomyClasses, boolean isSearchRelevant) throws ResourceException, WcmException, IOException
resource
- resource to indextaxonomyName
- name of the taxonomy where the taxonomy classes have to be indexed with the documenttaxonomyClasses
- taxonomy classes to index with the documentisSearchRelevant
- if true the document can be found in a search if false the document is only for the training of the taxonomy classesResourceException
- Exception raised in failure situationWcmException
- Exception raised in failure situationIOException
- Exception raised in failure situationpublic Collection classifyDocuments(IResourceList resourceDocuments, String taxonomyName, int maxResults) throws WcmException
resourceDocuments
- Resource list of documents you want to classifymaxResults
- maximum number of returned taxonomy classestaxonomyName
- name of the taxonomy whereWcmException
- Exception raised in failure situationpublic Collection classifyDocuments(IResourceList resourceDocuments, String taxonomyName) throws WcmException
resourceDocuments
- Resource list of documents you want to classifytaxonomyName
- name of the taxonomy for that classification proposals have to be foundWcmException
- Exception raised in failure situationpublic Collection unfilteredClassifyDocuments(IResourceList resourceDocuments, String taxonomyName, float threshold, int maxResults) throws WcmException
resourceDocuments
- Resource list of documents you want to classifythreshold
- lowest rank value of a returned taxonomy classmaxResults
- maximum number of returned taxonomy classestaxonomyName
- name of the taxonomy for that classification proposals have to be foundWcmException
- Exception raised in failure situationpublic Map unfilteredClassifyDocuments(IResource resource, List taxonomies, float threshold, int maxResults) throws WcmException
resource
- Resource you want to classifytaxonomies
- name of the taxonomies for which classification proposals have to be foundthreshold
- lowest rank value of a returned taxonomy classmaxResults
- maximum number of returned taxonomy classesWcmException
- Exception raised in failure situationpublic Collection classifyDocuments(IResourceList resourceDocuments, String taxonomyName, float threshold, int maxResults) throws WcmException
resourceDocuments
- Resource list of documents you want to classifythreshold
- lowest rank value of a returned taxonomy classmaxResults
- maximum number of returned taxonomy classestaxonomyName
- name of the taxonomy for that classification proposals have to be foundWcmException
- Exception raised in failure situationpublic Collection classifyDocuments(IResourceList resourceDocuments, String taxonomyName, float threshold, int maxResults, boolean checkIfInIndex) throws WcmException
resourceDocuments
- Resource list of documents you want to classifythreshold
- lowest rank value of a returned taxonomy classmaxResults
- maximum number of returned taxonomy classestaxonomyName
- name of the taxonomy for that classification proposals have to be foundcheckIfInIndex
- 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 againWcmException
- Exception raised in failure situationprotected Collection internalClassifyDocuments(IResourceList resourceDocuments, String taxonomyName, float threshold, int maxResults) throws WcmException
resourceDocuments
- Resource list of documents you want to classifythreshold
- lowest rank value of a returned taxonomy classmaxResults
- maximum number of returned taxonomy classestaxonomyName
- name of the taxonomy for that classification proposals have to be foundWcmException
- Exception raised in failure situationprotected Collection internalClassifyDocuments(IResourceList resourceDocuments, String taxonomyName, float threshold, int maxResults, boolean checkIfInIndex) throws WcmException
resourceDocuments
- Resource list of documents you want to classifythreshold
- lowest rank value of a returned taxonomy classmaxResults
- maximum number of returned taxonomy classestaxonomyName
- name of the taxonomy for that classification proposals have to be foundcheckIfInIndex
- 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 againWcmException
- Exception raised in failure situationprotected Map internalClassifyDocuments(IResource resource, List taxonomies, float threshold, int maxResults) throws WcmException
WcmException
public boolean useBestClasses()
protected abstract void internalIndexDocuments(IResourceList resources, String taxonomyName, IRidList taxonomyClasses, IResourceEvent resourceEvent, boolean isSearchRelevant, boolean reindexMode, boolean sendLinkEvents) throws ResourceException, WcmException, IOException
resources
- resources to indextaxonomyName
- name of the taxonomy where the taxonomy classes have to be indexed with the documenttaxonomyClasses
- taxonomy classes to index with the documentsresourceEvent
- resourceEventisSearchRelevant
- if true the documents can be found in a search if false the document is only for the training of the taxonomy classesreindexMode
- reindexModesendLinkEvents
- sendLinkEventsResourceException
- Exception raised in failure situationWcmException
- Exception raised in failure situationIOException
- Exception raised in failure situationprotected void internalIndexDocuments(IResourceList resources, IResourceEvent resourceEvent) throws ResourceException, WcmException, IOException
internalIndexDocuments
in class AbstractIndex
resources
- list of resources to indexresourceEvent
- event that caused the index requestResourceException
- Exception raised in failure situationWcmException
- Exception raised in failure situationIOException
- Exception raised in failure situationprotected abstract void indexDocumentClassification(IResource document, IIndexService indexService)
document
- document that has to be indexesindexService
- index service from the service factorypublic void finishXPostClear() throws WcmException
WcmException
- WcmExceptionprotected boolean reindexTrainingResources(IIndexFolderList preClearIndexFolders) throws WcmException
preClearIndexFolders
- preClearIndexFoldersWcmException
- WcmExceptionpublic void indexManualTrainDocs() throws WcmException
WcmException
- WcmExceptionpublic ClassificationStatus getDocumentClassificationStatus(IResource document, String taxonomyName) throws WcmException
document
- document to get the classification status fortaxonomyName
- name of the taxonomyWcmException
- WcmExceptionpublic ClassificationStatus getDocumentClassificationStatusNewEnum(IResource document, String taxonomyName) throws WcmException
document
- document to get the classification status fortaxonomyName
- name of the taxonomyWcmException
- WcmExceptionpublic void setOnlyAppPropertyDocClassificationStatus(IResource document, String taxonomyName, ClassificationStatus status) throws WcmException
document
- documenttaxonomyName
- taxonomyNamestatus
- statusWcmException
- WcmExceptionpublic void addOnlyAppPropManAssigned(IResource document, RID category) throws WcmException
document
- documentcategory
- categoryWcmException
- WcmExceptionpublic void addOnlyAppPropManDeclassified(IResource document, RID category) throws WcmException
document
- documentcategory
- categoryWcmException
- WcmExceptionpublic void setDocumentClassificationStatus(IResource document, String taxonomyName, ClassificationStatus status) throws WcmException
document
- document to get the classification status fortaxonomyName
- name of the taxonomystatus
- the documents classification status in the taxonomyWcmException
- WcmExceptionpublic void setDocumentClassificationStatus(IResource document, String taxonomyName, ClassificationStatus status, String notToSend) throws WcmException
document
- document to get the classification status fortaxonomyName
- name of the taxonomystatus
- the documents classification status in the taxonomynotToSend
- String describing an event, which should be suppressedWcmException
- WcmExceptionpublic void setDocumentClassificationStatus(IResource document, String taxonomyName, ClassificationStatus status, boolean sendEvents, String notToSend) throws WcmException
document
- document to get the classification status fortaxonomyName
- name of the taxonomystatus
- the documents classification status in the taxonomysendEvents
- only send events if truenotToSend
- String describing an event, which should be suppressedWcmException
- WcmExceptionpublic void setDocumentClassificationStatus(IResourceList documents, String taxonomyName, ClassificationStatus status) throws WcmException
documents
- documents to set the classification status fortaxonomyName
- name of the taxonomystatus
- the documents classification status in the taxonomyWcmException
- WcmExceptionpublic IResourceList getDocumentsToClassify(String taxonomyName) throws WcmException
taxonomyName
- name of the taxonomy for that the documents that are to classify should be returnedWcmException
- WcmExceptionpublic IResourceList getDocumentsToClassify(String taxonomyName, IResourceContext context) throws WcmException
taxonomyName
- name of the taxonomy for that the documents that are to classify should be returnedcontext
- user contextWcmException
- WcmExceptionpublic IResourceList getDocumentsNeverToClassify(String taxonomyName, IResourceContext context) throws WcmException
taxonomyName
- name of the taxonomy for that the documents that are never to be classified should be returnedcontext
- user contextWcmException
- WcmExceptionpublic IResourceList getDocumentsNeverToClassify(String taxonomyName) throws WcmException
taxonomyName
- name of the taxonomy for that the documents that are never to be classified should be returnedWcmException
- WcmExceptionpublic IRidList getDocumentRidsToClassify(String taxonomyName, IResourceContext context) throws WcmException
taxonomyName
- name of the taxonomy for that the documents that are to classify should be returnedcontext
- user contextWcmException
- WcmExceptionpublic IRidList getDocumentRidsNeverToClassify(String taxonomyName, IResourceContext context) throws WcmException
taxonomyName
- name of the taxonomy for that the documents that are never to be classified should be returnedcontext
- user contextWcmException
- WcmExceptionpublic RID getSpecialFolderRID(String taxonomyName, SpecialFolder specialFolderType) throws WcmException
taxonomyName
- name of the taxonomyspecialFolderType
- type of special folderWcmException
- WcmExceptionpublic IDocClassificationMap getDocClassification(IResource document) throws WcmException
document
- document for that the classification has to be returnedWcmException
- Exception raised in failure situationpublic IDocClassificationMap getDocClassification(IResource document, IResourceContext context) throws WcmException
document
- document for that the classification has to be returnedcontext
- contextWcmException
- Exception raised in failure situationpublic IDocClassificationMapList getDocListClassification(IResourceList documents) throws WcmException
documents
- list of documents for that the classification has to be returnedWcmException
- Exception raised in failure situation.public IDocClassificationMapList getDocListClassification(IResourceList documents, IResourceContext context) throws WcmException
documents
- list of documents for that the classification has to be returnedcontext
- contextWcmException
- Exception raised in failure situation.public void setDocClassification(IDocClassificationMap documentClassificationMap) throws WcmException
documentClassificationMap
- container with the document and its classification for all taxonomiesWcmException
- Exception raised in failure situationpublic void setDocClassification(IDocClassificationMap documentClassificationMap, String notToSend) throws WcmException
documentClassificationMap
- container with the document and its classification for all taxonomiesnotToSend
- String describing an event, which should be suppressedWcmException
- Exception raised in failure situationpublic void setDocClassification(IDocClassificationMap documentClassificationMap, boolean indexDocumentClassification) throws WcmException
documentClassificationMap
- container with the document and its classification for all taxonomiesindexDocumentClassification
- if true the document classification is indexed. If false the document
classification is only stored as an application property with the document and is not indexed. Warning: Should
only be "false" if document is indexed immediately before or after the call by another routine.WcmException
- Exception raised in failure situationpublic void setDocClassification(IDocClassificationMap documentClassificationMap, boolean indexDocumentClassification, boolean isTrainingDocument) throws WcmException
documentClassificationMap
- container with the document and its classification for all taxonomiesindexDocumentClassification
- if true the document classification is indexed. If false the document
classification is only stored as an application property with the document and is not indexed. Warning: Should
only be "false" if document is indexed immediately before or after the call by another routine.isTrainingDocument
- if true the classification is is indexed to train the indexWcmException
- Exception raised in failure situationpublic void setDocClassification(IDocClassificationMap documentClassificationMap, boolean indexDocumentClassification, boolean isTrainingDocument, boolean sendLinkEvents) throws WcmException
documentClassificationMap
- container with the document and its classification for all taxonomiesindexDocumentClassification
- if true the document classification is indexed. If false the document
classification is only stored as an application property with the document and is not indexed. Warning: Should
only be "false" if document is indexed immediately before or after the call by another routine.isTrainingDocument
- if true the classification is is indexed to train the indexsendLinkEvents
- if true create link event will be sendWcmException
- Exception raised in failure situationpublic void setDocClassification(IDocClassificationMap documentClassificationMap, boolean indexDocumentClassification, boolean isTrainingDocument, boolean sendLinkEvents, String notToSend) throws WcmException
documentClassificationMap
- container with the document and its classification for all taxonomiesindexDocumentClassification
- if true the document classification is indexed. If false the document
classification is only stored as an application property with the document and is not indexed. Warning: Should
only be "false" if document is indexed immediately before or after the call by another routine.isTrainingDocument
- if true the classification is is indexed to train the indexsendLinkEvents
- if true create link event will be sendnotToSend
- String describing an event, which should be suppressedWcmException
- Exception raised in failure situationpublic List getClassesStringList(IDocClassificationMap documentClassification)
documentClassification
- documentClassificationpublic void setDocListClassification(IDocClassificationMapList documentClassificationMapList) throws WcmException
documentClassificationMapList
- list of containers with the document and its classification for all taxonomiesWcmException
- Exception raised in failure situationpublic void setTaxonomyType(String taxonomyName, TaxonomyType taxonomyType) throws WcmException
taxonomyName
- name of the taxonomytaxonomyType
- new taxonomy typeWcmException
- WcmExceptionpublic void setIndexOnlyClassifiedDocs(boolean indexOnlyClassifiedDocs) throws WcmException
indexOnlyClassifiedDocs
- indexOnlyClassifiedDocsWcmException
- WcmExceptionpublic TaxonomyType getTaxonomyType(String taxonomyName) throws WcmException
taxonomyName
- the name of the taxonomyWcmException
- WcmExceptionpublic TaxonomyType getTaxonomyTypeNewEnum(String taxonomyName) throws WcmException
taxonomyName
- the name of the taxonomyWcmException
- WcmExceptionpublic boolean isIndexOnlyClassifiedDocs() throws WcmException
WcmException
- WcmExceptionpublic IQueryFolder getQueryFolder(RID taxonomyClassRid) throws WcmException
taxonomyClassRid
- rid of the taxonomy class that is the query folderWcmException
- WcmExceptionpublic IRidList getDocumentTrainingClasses(IResource document) throws WcmException
document
- document for that the training classes have to be returnedWcmException
- WcmExceptionpublic IRidList getManuallyDeclassifiedClasses(IResource document) throws WcmException
document
- document for that the manually declassified classes have to be returnedWcmException
- WcmExceptionpublic void autoClassifyDocs(String taxonomyName, IRidList docRidList, IResourceContext context) throws WcmException
taxonomyName
- name of the taxonomydocRidList
- list IDs of documents of a taxonomy to be reclassifiedcontext
- user contextWcmException
- WcmExceptionpublic void autoClassifyDocs(String taxonomyName, IResourceList docList, IResourceContext context) throws WcmException
taxonomyName
- name of the taxonomydocList
- list of documents of a taxonomy to be reclassifiedcontext
- user contextWcmException
- WcmExceptionpublic void autoClassifyDocs(String taxonomyName, IResourceContext context) throws WcmException
taxonomyName
- name of the taxonomycontext
- user contextWcmException
- WcmExceptionprotected void deleteTaxRmIndexFolder(IResourceContext context) throws WcmException
IClassificationIndex
.context
- contextWcmException
- WcmExceptionprotected ICollection createTaxRmIndexFolder(IResourceContext context) throws WcmException
IClassificationIndex
.context
- contextWcmException
- WcmExceptionpublic void removeCategoryAssignments(ICollection deletedCategoryFolder) throws WcmException
deletedCategoryFolder
- deletedCategoryFolderWcmException
- WcmExceptionpublic void deleteIndexTaxDocClassification(IRidList documentIDs) throws WcmException
documentIDs
- documents for that the classification has to be removedWcmException
- WcmExceptionprotected IPropertyName getPropertyNameTaxonomy(String taxonomyName) throws WcmException
taxonomyName
- taxonomyNameWcmException
- WcmExceptionpublic static IPropertyName getPropertyNameTrainingClasses() throws WcmException
WcmException
- WcmExceptionpublic static IPropertyName getPropertyNameManuallyDeclassifiedClasses() throws WcmException
WcmException
- WcmExceptionpublic IRidList getClassTrainingDocuments(RID categoryRid, IResourceContext context) throws WcmException
categoryRid
- categoryRidcontext
- contextWcmException
- WcmExceptionpublic IRidList getClassTrainingDocuments(RID categoryRid, IResourceContext context, IApplicationProperties appPropService) throws WcmException
categoryRid
- categoryRidcontext
- contextappPropService
- appPropServiceWcmException
- WcmExceptionpublic IRidList getClassDeclassifiedDocuments(RID categoryRid, IResourceContext context) throws WcmException
categoryRid
- categoryRidcontext
- contextWcmException
- WcmExceptionpublic IRidList getClassDeclassifiedDocuments(RID categoryRid, IResourceContext context, IApplicationProperties appPropService) throws WcmException
categoryRid
- categoryRidcontext
- contextappPropService
- appPropServiceWcmException
- WcmExceptionpublic abstract void updateCategoryContents(String taxonomyName, boolean dirtyOnly, IResourceContext context) throws WcmException
taxonomyName
- name of the taxonomy to checkdirtyOnly
- if false all categories are checked, if false only categories
that are out of sync (dirty) are updated.context
- user contextWcmException
- WcmExceptionprotected void addResourceToClassificationIndex(RID resourceRID, IResourceContext context) throws WcmException
resourceRID
- ID of the resource to addcontext
- user contextWcmException
- WcmExceptionprotected void removeResourceFromClassificationIndex(RID resourceRID, IResourceContext context) throws WcmException
resourceRID
- ID of the resource to removecontext
- user contextWcmException
- WcmExceptionpublic void synchronizeTaxonomyMetaData(String taxonomyName) throws WcmException
taxonomyName
- taxonomy that has to be redefinedWcmException
- WcmExceptionpublic void deleteClassificationProperties(IResource resource) throws WcmException
resource
- resourceWcmException
- WcmExceptionpublic static void getAllCollections(ICollection col, IResourceList resources)
col
- colresources
- resourcespublic UpdateTaxonomyState getUpdateTaxonomyState(String taxonomyName) throws WcmException
taxonomyName
- taxonomyNameWcmException
- WcmExceptionpublic UpdateTaxonomyState getUpdateTaxonomyState(String taxonomyName, Locale locale) throws WcmException
taxonomyName
- taxonomyNamelocale
- localeWcmException
- WcmExceptionpublic void setUpdateTaxonomyState(String state, String taxonomyName, int visitedCategories, int catgoriesToUpdate, int allCategories) throws WcmException
state
- statetaxonomyName
- taxonomyNamevisitedCategories
- visitedCategoriescatgoriesToUpdate
- catgoriesToUpdateallCategories
- allCategoriesWcmException
- WcmExceptionpublic void checkUpdateTaxonomyStateDuringStartUp() throws WcmException
WcmException
- WcmExceptionpublic void setQueryFolderExternalFast(IQueryFolder queryFolder, IQueryEntryList query) throws WcmException
queryFolder
- the query folderquery
- the queryWcmException
- WcmExceptionpublic boolean multiTaxonomyClassificationPossible()
public static Map getDocumentTaxRMRids(RID taxonomyClassRid, IResourceList documents) throws WcmException
taxonomyClassRid
- the taxonomy RIDdocuments
- documentsWcmException
- WcmExceptionpublic static RID getDocumentTaxRMRid(RID taxonomyClassRid, RID documentRid) throws WcmException
taxonomyClassRid
- the taxonomy RIDdocumentRid
- the document RIDWcmException
- WcmExceptionpublic static RID makeDocTaxRmRid(RID taxonomyClassRid, RID documentRid, String docGuid)
taxonomyClassRid
- the taxonomy RIDdocumentRid
- the document RIDdocGuid
- the document GUIDpublic static RID getDocumentReplaceName(RID documentRid) throws WcmException
documentRid
- documentRidWcmException
- WcmExceptionpublic static RID getTargetRIDFromReplaceName(RID linkRid) throws WcmException
linkRid
- linkRidWcmException
- WcmExceptionpublic static RID getRIDFromConstantID(String guid) throws WcmException
guid
- guidWcmException
- WcmExceptionpublic static void clearGuidCache()
Access Rights |
---|
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
|
Copyright 2018 SAP AG Complete Copyright Notice