Package org.apache.lucene.facet.taxonomy
Class FacetLabel
java.lang.Object
org.apache.lucene.facet.taxonomy.FacetLabel
- All Implemented Interfaces:
Comparable<FacetLabel>
Holds a sequence of string components, specifying the hierarchical name of a category.
- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
Field Summary
FieldsModifier and TypeFieldDescriptionfinal String[]The components of thisFacetLabel.final intThe number of components of thisFacetLabel.static final intThe maximum number of characters aFacetLabelcan have. -
Constructor Summary
ConstructorsConstructorDescriptionFacetLabel(String... components) Construct from the given path components.FacetLabel(String dim, String[] path) Construct from the dimension plus the given path components. -
Method Summary
Modifier and TypeMethodDescriptionintcompareTo(FacetLabel other) Compares this path with anotherFacetLabelfor lexicographic order.booleaninthashCode()Get the last component.longCalculate a 64-bit hash function for this path.subpath(int length) Returns a sub-path of this path up tolengthcomponents.toString()Returns a string representation of the path.
-
Field Details
-
MAX_CATEGORY_PATH_LENGTH
public static final int MAX_CATEGORY_PATH_LENGTHThe maximum number of characters aFacetLabelcan have.- See Also:
-
components
The components of thisFacetLabel. Note that this array may be shared with otherFacetLabelinstances, e.g. as a result ofsubpath(int), therefore you should traverse the array up tolengthfor this path's components. -
length
public final int lengthThe number of components of thisFacetLabel.
-
-
Constructor Details
-
FacetLabel
Construct from the given path components. -
FacetLabel
Construct from the dimension plus the given path components.
-
-
Method Details
-
compareTo
Compares this path with anotherFacetLabelfor lexicographic order.- Specified by:
compareToin interfaceComparable<FacetLabel>
-
equals
-
hashCode
public int hashCode() -
longHashCode
public long longHashCode()Calculate a 64-bit hash function for this path. This is necessary forNameHashIntCacheLRU(the default cache impl forLruTaxonomyWriterCache) to reduce the chance of "silent but deadly" collisions. -
subpath
Returns a sub-path of this path up tolengthcomponents. -
lastComponent
Get the last component. -
toString
Returns a string representation of the path.
-