Class ContainerExtractorPath
java.lang.Object
org.hibernate.search.mapper.pojo.extractor.mapping.programmatic.ContainerExtractorPath
A chain of
container extractors
to be applied one after the other to a property value,
in order to extract other values.
The extractors are either represented:
- explicitly by their name, e.g.
["map-values", "collection"]
, meaning "apply the 'map-values' extractor to the property value, then apply the 'collection' extractor to the map values". Names are eitherbuilt-in
orregistered at bootstrap
. - or simply by the "default" path (
defaultExtractors()
), which means "whatever default Hibernate Search manages to apply using its internal extractor resolution algorithm". This second form may result in different "resolved" paths depending on the type of the property it is applied to.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionstatic ContainerExtractorPath
boolean
static ContainerExtractorPath
explicitExtractor
(String extractorName) static ContainerExtractorPath
explicitExtractors
(List<String> extractorNames) int
hashCode()
boolean
boolean
isEmpty()
static ContainerExtractorPath
toString()
-
Method Details
-
defaultExtractors
- Returns:
- A path that will apply the default extractor(s) based on the property type.
-
noExtractors
- Returns:
- A path that will not apply any container extractor.
-
explicitExtractor
- Parameters:
extractorName
- A container extractor referenced by its name.- Returns:
- A path that will apply the referenced container extractor.
- See Also:
-
explicitExtractors
- Parameters:
extractorNames
- A list of container extractors referenced by their name.- Returns:
- A path that will apply the referenced container extractors in order.
-
equals
-
hashCode
public int hashCode() -
toString
-
isDefault
public boolean isDefault()- Returns:
true
if this path represents the default extractor(s), which will be determined automatically based on the property type.false
otherwise.
-
isEmpty
public boolean isEmpty()- Returns:
true
if this path is empty, i.e. it represents direct access to the property value.false
otherwise.
-
explicitExtractorNames
- Returns:
- The list of extractor names explicitly referenced by this path. Empty if this path represents the default extractor(s).
-