info.aduna.gee.spectacle.gee
Class FacetLevelClassifier

java.lang.Object
  info.aduna.gee.spectacle.gee.FacetLevelClassifier

All Implemented Interfaces:

FacetClassifier, Classifier

public class FacetLevelClassifier
extends Object
implements FacetClassifier

Field Summary

Fields inherited from interface info.aduna.gee.spectacle.gee.Classifier

BY_CLASSIFICATION, BY_ENTITY

Constructor Summary

FacetLevelClassifier(FacetClassifier parent, int level)

Method Summary

Object	getAccessMethod()
Set<Object>	getClassifications(int level)
List<Set<Object>>	getClassifications(Object entityID)
int	getDepth()
Set<Object>	getEntityIDs(Object classification, int level)
String	getFacetName() Should return the facet name for which this classifier handles the classification; this is usually the actual name shown on screen.
String	getInternalFacetName()
void	init(Map<Object,Entity> entities) Invoked by spectacle just before this classifier has to do its work using the 'getClassifications' method(s).

Methods inherited from class java.lang.Object

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

Constructor Detail

FacetLevelClassifier

public FacetLevelClassifier(FacetClassifier parent,
                            int level)

Method Detail

getFacetName

public String getFacetName()

Description copied from interface: FacetClassifier

Should return the facet name for which this classifier handles the classification; this is usually the actual name shown on screen.

Specified by:

getFacetName in interface FacetClassifier

getInternalFacetName

public String getInternalFacetName()

Specified by:

getInternalFacetName in interface FacetClassifier

Returns:

the internal facet name for which this classifier handles the classification; this is might differ from the actual name shown on screen.

getClassifications

public List<Set<Object>> getClassifications(Object entityID)

Specified by:

getClassifications in interface Classifier

Parameters:

entityID - a unique identifier of an Entity

Returns:

a List of sets of Classifications only used for BY_ENTITY

init

public void init(Map<Object,Entity> entities)

Description copied from interface: FacetClassifier

Invoked by spectacle just before this classifier has to do its work using the 'getClassifications' method(s).

Specified by:

init in interface FacetClassifier

getAccessMethod

public Object getAccessMethod()

Specified by:

getAccessMethod in interface Classifier

Returns:

one of BY_CLASSIFICATION, BY_ENTITY

getClassifications

public Set<Object> getClassifications(int level)

Specified by:

getClassifications in interface Classifier

Parameters:

level - the level (0 based)

Returns:

a set of Classifications only used for BY_CLASSIFICATION

getDepth

public int getDepth()

Specified by:

getDepth in interface Classifier

Returns:

the depth

getEntityIDs

public Set<Object> getEntityIDs(Object classification,
                                int level)

Specified by:

getEntityIDs in interface Classifier

Parameters:

classification - the classification

level - the level of the classification (0 based)

Returns:

a set of Object Entity ids only used for BY_CLASSIFICATION