Class LabelToOrdinal
- java.lang.Object
-
- org.apache.lucene.facet.taxonomy.writercache.cl2o.LabelToOrdinal
-
- Direct Known Subclasses:
CompactLabelToOrdinal
public abstract class LabelToOrdinal extends Object
Abstract class for storing Label->Ordinal mappings in a taxonomy.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Field Summary
Fields Modifier and Type Field Description protected int
counter
static int
InvalidOrdinal
-
Constructor Summary
Constructors Constructor Description LabelToOrdinal()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
addLabel(CategoryPath label, int ordinal)
Adds a new label if its not yet in the table.abstract void
addLabel(CategoryPath label, int prefixLen, int ordinal)
Adds a new label if its not yet in the table.int
getMaxOrdinal()
return the maximal Ordinal assigned so farint
getNextOrdinal()
Returns the next unassigned ordinal.abstract int
getOrdinal(CategoryPath label)
abstract int
getOrdinal(CategoryPath label, int prefixLen)
-
-
-
Field Detail
-
counter
protected int counter
-
InvalidOrdinal
public static final int InvalidOrdinal
- See Also:
- Constant Field Values
-
-
Method Detail
-
getMaxOrdinal
public int getMaxOrdinal()
return the maximal Ordinal assigned so far
-
getNextOrdinal
public int getNextOrdinal()
Returns the next unassigned ordinal. The default behavior of this method is to simply increment a counter.
-
addLabel
public abstract void addLabel(CategoryPath label, int ordinal)
Adds a new label if its not yet in the table. Throws anIllegalArgumentException
if the same label with a different ordinal was previoulsy added to this table.
-
addLabel
public abstract void addLabel(CategoryPath label, int prefixLen, int ordinal)
Adds a new label if its not yet in the table. Throws anIllegalArgumentException
if the same label with a different ordinal was previoulsy added to this table.
-
getOrdinal
public abstract int getOrdinal(CategoryPath label)
- Returns:
- the ordinal assigned to the given label,
or
InvalidOrdinal
if the label cannot be found in this table.
-
getOrdinal
public abstract int getOrdinal(CategoryPath label, int prefixLen)
- Returns:
- the ordinal assigned to the given label,
or
InvalidOrdinal
if the label cannot be found in this table.
-
-