Package org.apache.lucene.facet.taxonomy

Class FacetLabel

  • All Implemented Interfaces:
    java.lang.Comparable<FacetLabel>
    public class FacetLabel
extends java.lang.Object
implements java.lang.Comparable<FacetLabel>
    Holds a sequence of string components, specifying the hierarchical name of a category.

    • Constructor Summary

      Constructors 
      Constructor Description
      FacetLabel​(java.lang.String... components)
      Construct from the given path components.
      FacetLabel​(java.lang.String dim, java.lang.String[] path)
      Construct from the dimension plus the given path components.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int compareTo​(FacetLabel other)
      Compares this path with another FacetLabel for lexicographic order.
      boolean equals​(java.lang.Object obj)  
      int hashCode()  
      long longHashCode()
      Calculate a 64-bit hash function for this path.
      FacetLabel subpath​(int length)
      Returns a sub-path of this path up to length components.
      java.lang.String toString()
      Returns a string representation of the path.

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • MAX_CATEGORY_PATH_LENGTH

        public static final int MAX_CATEGORY_PATH_LENGTH
        The maximum number of characters a FacetLabel can have.
        See Also:
        Constant Field Values

      • components

        public final java.lang.String[] components
        The components of this FacetLabel. Note that this array may be shared with other FacetLabel instances, e.g. as a result of subpath(int), therefore you should traverse the array up to length for this path's components.

      • length

        public final int length
        The number of components of this FacetLabel.

    • Constructor Detail

      • FacetLabel

        public FacetLabel​(java.lang.String... components)
        Construct from the given path components.

      • FacetLabel

        public FacetLabel​(java.lang.String dim,
                  java.lang.String[] path)
        Construct from the dimension plus the given path components.

    • Method Detail

      • compareTo

        public int compareTo​(FacetLabel other)
        Compares this path with another FacetLabel for lexicographic order.
        Specified by:
        compareTo in interface java.lang.Comparable<FacetLabel>

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • longHashCode

        public long longHashCode()
        Calculate a 64-bit hash function for this path. This is necessary for NameHashIntCacheLRU (the default cache impl for LruTaxonomyWriterCache) to reduce the chance of "silent but deadly" collisions.

      • subpath

        public FacetLabel subpath​(int length)
        Returns a sub-path of this path up to length components.

      • toString

        public java.lang.String toString()
        Returns a string representation of the path.
        Overrides:
        toString in class java.lang.Object