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

Interface IDocClassificationMap

All Known Implementing Classes:

DocClassificationMap

public interface IDocClassificationMap

This map contains a resource and its classification per taxonomy

Method Summary

Modifier and Type	Method and Description
boolean	containsTaxonomyName(String taxonomyName)
IRidList	getClasses(String taxonomyName) Get the Classes attribute of the IDocClassificationMap object.
IResource	getDocument() Get the Document attribute of the IDocClassificationMap object.
Set	getTaxonomyNameSet() Get the TaxonomySet attribute of the IDocClassificationMap object.
void	put(String taxonomyName, IRidList taxClasses) Puts a classification for a taxonomy into the map
void	putAll(IDocClassificationMap documentClassificationMap)
void	removeTaxonomyClasses(String taxonomyName) Removes the taxonomy with its classes from the map

Method Detail

getDocument

IResource getDocument()

Get the Document attribute of the IDocClassificationMap object.

Returns:

The Document value

getClasses

IRidList getClasses(String taxonomyName)

Get the Classes attribute of the IDocClassificationMap object.

Parameters:

taxonomyName - taxonomy name for that the classes have to be returned

Returns:

The Classes value

getTaxonomyNameSet

Set getTaxonomyNameSet()

Get the TaxonomySet attribute of the IDocClassificationMap object.

Returns:

the set of taxonomy names for that classifications are available within the map (set contains (String)taxonomy names)

put

void put(String taxonomyName,
         IRidList taxClasses)

Puts a classification for a taxonomy into the map

Parameters:

taxonomyName - name of the taxonomy

taxClasses - list of taxonomy classes

putAll

void putAll(IDocClassificationMap documentClassificationMap)

Parameters:

documentClassificationMap - the classificationMap that has to be put into this map

containsTaxonomyName

boolean containsTaxonomyName(String taxonomyName)

Parameters:

taxonomyName - name of the taxonomy

Returns:

true if the map contains the taxonomy name as key for taxonomy classes

removeTaxonomyClasses

void removeTaxonomyClasses(String taxonomyName)

Removes the taxonomy with its classes from the map

Parameters:

taxonomyName - name of the taxonomy