Class OrdinalProperty
- java.lang.Object
-
- org.apache.lucene.facet.index.attributes.OrdinalProperty
-
- All Implemented Interfaces:
Serializable
,CategoryProperty
public class OrdinalProperty extends Object implements CategoryProperty
ACategoryProperty
holding the ordinal from the taxonomy of the current category inCategoryAttribute
.Ordinal properties are added internally during processing of category streams, and it is recommended not to use it externally.
- See Also:
- Serialized Form
- 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
ordinal
-
Constructor Summary
Constructors Constructor Description OrdinalProperty()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clear()
boolean
equals(Object other)
int
getOrdinal()
boolean
hasBeenSet()
int
hashCode()
void
merge(CategoryProperty other)
When adding categories with properties to a certain document, it is possible that the same category will be added more than once with different instances of the same property.void
setOrdinal(int value)
-
-
-
Method Detail
-
getOrdinal
public int getOrdinal()
-
hasBeenSet
public boolean hasBeenSet()
-
setOrdinal
public void setOrdinal(int value)
-
clear
public void clear()
-
merge
public void merge(CategoryProperty other)
Description copied from interface:CategoryProperty
When adding categories with properties to a certain document, it is possible that the same category will be added more than once with different instances of the same property. This method defined how to treat such cases, by merging the newly added property into the one previously added. Implementing classes can assume that this method will be called only with a property of the same class.- Specified by:
merge
in interfaceCategoryProperty
- Parameters:
other
- The category property to merge.
-
-