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

Class DocClassificationMap

java.lang.Object

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

All Implemented Interfaces:

IDocClassificationMap

public class DocClassificationMap
extends Object
implements IDocClassificationMap

Contains a resource and its classification per taxonomy.

Constructor Summary

Constructors

Constructor and Description
DocClassificationMap(IResource document)

Method Summary

Modifier and Type	Method and Description
boolean	containsTaxonomyName(String taxonomyName)
boolean	equals(IDocClassificationMap docClassificationMap) True if the index folder is equal to another index folder.
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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocClassificationMap

public DocClassificationMap(IResource document)

Parameters:

document - the document

Method Detail

getDocument

public IResource getDocument()

Get the Document attribute of the IDocClassificationMap object.

Specified by:

getDocument in interface IDocClassificationMap

Returns:

The Document value

getClasses

public IRidList getClasses(String taxonomyName)

Get the Classes attribute of the IDocClassificationMap object.

Specified by:

getClasses in interface IDocClassificationMap

Parameters:

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

Returns:

The Classes value

getTaxonomyNameSet

public Set getTaxonomyNameSet()

Get the TaxonomySet attribute of the IDocClassificationMap object.

Specified by:

getTaxonomyNameSet in interface IDocClassificationMap

Returns:

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

put

public void put(String taxonomyName,
                IRidList taxClasses)

Puts a classification for a taxonomy into the map

Specified by:

put in interface IDocClassificationMap

Parameters:

taxonomyName - name of the taxonomy

taxClasses - list of taxonomy classes

equals

public boolean equals(IDocClassificationMap docClassificationMap)

True if the index folder is equal to another index folder. This is the case if the indexId and the rid of the index folder are equal.

Parameters:

docClassificationMap - other index folder to test if it is equal to this index folder

Returns:

true if equal, false if not equal.

containsTaxonomyName

public boolean containsTaxonomyName(String taxonomyName)

Specified by:

containsTaxonomyName in interface IDocClassificationMap

Parameters:

taxonomyName - name of the taxonomy

Returns:

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

putAll

public void putAll(IDocClassificationMap documentClassificationMap)

Specified by:

putAll in interface IDocClassificationMap

Parameters:

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

removeTaxonomyClasses

public void removeTaxonomyClasses(String taxonomyName)

Removes the taxonomy with its classes from the map

Specified by:

removeTaxonomyClasses in interface IDocClassificationMap

Parameters:

taxonomyName - name of the taxonomy