Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

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

[contained in: com.sap.km.cm.service.par - km.shared.service.indexmanagement_api.jar] 
java.lang.Object
  |
  +--com.sapportals.wcm.service.indexmanagement.retrieval.classification.DocClassificationMap
All Implemented Interfaces:
IDocClassificationMap
public class DocClassificationMap
extends java.lang.Object
implements IDocClassificationMap

Contains a resource and its classification per taxonomy.

Constructor Summary
DocClassificationMap(IResource document)
           
 
Method Summary
 boolean containsTaxonomyName(java.lang.String taxonomyName)
           
 boolean equals(IDocClassificationMap docClassificationMap)
          True if the index folder is equal to another index folder.
 IRidList getClasses(java.lang.String taxonomyName)
          Get the Classes attribute of the IDocClassificationMap object.
 IResource getDocument()
          Get the Document attribute of the IDocClassificationMap object.
 java.util.Set getTaxonomyNameSet()
          Get the TaxonomySet attribute of the IDocClassificationMap object.
 void put(java.lang.String taxonomyName, IRidList taxClasses)
          Puts a classification for a taxonomy into the map
 void putAll(IDocClassificationMap documentClassificationMap)
           
 void removeTaxonomyClasses(java.lang.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)
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(java.lang.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 java.util.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(java.lang.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:
indexFolder - 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(java.lang.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(java.lang.String taxonomyName)
Removes the taxonomy with its classes from the map
Specified by:
removeTaxonomyClasses in interface IDocClassificationMap
Parameters:
taxonomyName - name of the taxonomy
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.