Package org.apache.solr.schema

Class NestPathField

java.lang.Object

org.apache.solr.schema.FieldProperties

org.apache.solr.schema.FieldType

org.apache.solr.schema.PrimitiveFieldType

org.apache.solr.schema.StrField

org.apache.solr.schema.NestPathField

public class NestPathField
extends StrField

To be used for field IndexSchema.NEST_PATH_FIELD_NAME for enhanced nested doc information. By defining a field type, we can encapsulate the configuration here so that the schema is free of it. Alternatively, some notion of "implicit field types" would be cool and a more general way of accomplishing this.

Since:

8.0

See Also:

• NestedUpdateProcessorFactory

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.solr.schema.FieldType

FieldType.DefaultAnalyzer, FieldType.MultiValueSelector

Field Summary

Fields inherited from class org.apache.solr.schema.FieldType

ANALYZER, args, AUTO_GENERATE_PHRASE_QUERIES, CHAR_FILTER, CHAR_FILTERS, CLASS_NAME, docValuesFormat, ENABLE_GRAPH_QUERIES, falseProperties, FILTER, FILTERS, INDEX, INDEX_ANALYZER, MULTI_TERM, MULTI_TERM_ANALYZER, POLY_FIELD_SEPARATOR, postingsFormat, properties, QUERY, QUERY_ANALYZER, similarity, SIMILARITY, similarityFactory, SYNONYM_QUERY_STYLE, TOKENIZER, trueProperties, TYPE, TYPE_NAME, typeName

Fields inherited from class org.apache.solr.schema.FieldProperties

BINARY, DOC_VALUES, INDEXED, LARGE_FIELD, MULTIVALUED, OMIT_NORMS, OMIT_POSITIONS, OMIT_TF_POSITIONS, REQUIRED, SORT_MISSING_FIRST, SORT_MISSING_LAST, STORE_OFFSETS, STORE_TERMOFFSETS, STORE_TERMPAYLOADS, STORE_TERMPOSITIONS, STORE_TERMVECTORS, STORED, TOKENIZED, UNINVERTIBLE, USE_DOCVALUES_AS_STORED

Constructor Summary

Constructors

Constructor	Description
NestPathField()

Method Summary

Modifier and Type	Method	Description
List<org.apache.lucene.index.IndexableField>	createFields(SchemaField field, Object value)	Given a SchemaField, create one or more IndexableField instances
org.apache.lucene.search.Query	getFieldQuery(QParser parser, SchemaField field, String externalVal)	Returns a Query instance for doing searches against a field.
void	setArgs(IndexSchema schema, Map<String,String> args)	Initializes the field type.
String	toInternal(String val)	Convert an external value (from XML update command or from query string) into the internal format for both storing and indexing (which can be modified by any analyzers).

Methods inherited from class org.apache.solr.schema.StrField

getBytesRef, getSingleValueSource, getSortField, getUninversionType, getValueSource, init, isUtf8Field, marshalSortValue, toObject, unmarshalSortValue, write

Methods inherited from class org.apache.solr.schema.PrimitiveFieldType

checkSupportsDocValues, enableDocValuesByDefault, getDefaultMultiValueSelectorForSort

Methods inherited from class org.apache.solr.schema.FieldType

checkSchemaField, createField, createField, createFieldsFromAllValues, getAnalyzerProperties, getClassArg, getDocValuesFormat, getExistenceQuery, getFieldTermQuery, getIndexAnalyzer, getNamedPropertyValues, getNonFieldPropertyArgs, getNumberType, getNumericSort, getPostingsFormat, getPrefixQuery, getQueryAnalyzer, getRangeQuery, getRewriteMethod, getSetQuery, getSimilarity, getSimilarityFactory, getSortedNumericSortField, getSortedSetSortField, getSortField, getSpecializedExistenceQuery, getSpecializedRangeQuery, getStringSort, getTypeName, hasProperty, indexedToReadable, indexedToReadable, isExplicitAnalyzer, isExplicitQueryAnalyzer, isMultiValued, isPointField, isPolyField, isTokenized, marshalBase64SortValue, marshalStringSortValue, multiValuedFieldCache, readableToIndexed, readableToIndexed, restrictProps, setIndexAnalyzer, setIsExplicitAnalyzer, setIsExplicitQueryAnalyzer, setQueryAnalyzer, setSimilarity, shouldCreateFieldsFromAllValues, storedToIndexed, storedToReadable, supportsAnalyzers, toExternal, toNativeType, toObject, toString, treatUnboundedRangeAsExistence, unmarshalBase64SortValue, unmarshalStringSortValue, useDocValuesAsStored, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

NestPathField

public NestPathField()

Method Details

setArgs

public void setArgs(IndexSchema schema,
 Map<String,String> args)

Description copied from class: FieldType

Initializes the field type. Subclasses should usually override FieldType.init(IndexSchema, Map) which is called by this method.

Overrides:

setArgs in class FieldType

createFields

public List<org.apache.lucene.index.IndexableField> createFields(SchemaField field,
 Object value)

Given a SchemaField, create one or more IndexableField instances Overridden to manipulate the indexed form (AKA terms), but not the DV form. The value may look something like /childA#0/childB#23 and we want to strip out the pound-digits aspects.

The terms index is used for block-join and docValues is used for returning nested docs in the same structure as given.

Overrides:

createFields in class StrField

Parameters:

field - the SchemaField

value - The value to add to the field

Returns:

An array of IndexableField

See Also:

• toInternal(String)

toInternal

public String toInternal(String val)

Description copied from class: FieldType

Convert an external value (from XML update command or from query string) into the internal format for both storing and indexing (which can be modified by any analyzers).

Overrides:

toInternal in class FieldType

See Also:

• FieldType.toExternal(org.apache.lucene.index.IndexableField)

getFieldQuery

public org.apache.lucene.search.Query getFieldQuery(QParser parser,
 SchemaField field,
 String externalVal)

Description copied from class: FieldType

Returns a Query instance for doing searches against a field.

Overrides:

getFieldQuery in class FieldType

Parameters:

parser - The QParser calling the method

field - The SchemaField of the field to search

externalVal - The String representation of the value to search

Returns:

The Query instance. This implementation returns a TermQuery but overriding queries may not