public class ExternalFileField extends FieldType
keyField will normally be the unique key field, but it doesn't have to be.
valType is a reference to another fieldType to define the value type of this field
(must currently be TrieFloatField or FloatField (valType="pfloat|float|tfloat") if used).
This parameter has never been implemented. As of Solr 3.6/4.0 it is optional and can be omitted.
The format of the external file is simply newline separated keyFieldValue=floatValue.
doc33=1.414
doc34=3.14159
doc40=42
Solr looks for the external file in the index directory under the name of
external_<fieldname> or external_<fieldname>.*
If any files of the latter pattern appear, the last (after being sorted by name) will be used and previous versions will be deleted.
This is to help support systems where one may not be able to overwrite a file (like Windows, if the file is in use).
If the external file has already been loaded, and it is changed, those changes will not be visible until a commit has been done.
The external file may be sorted or unsorted by the key field, but it will be substantially slower (untested) if it isn't sorted.
Fields of this type may currently only be used as a ValueSource in a FunctionQuery.FieldType.DefaultAnalyzeranalyzer, args, falseProperties, log, POLY_FIELD_SEPARATOR, queryAnalyzer, trueProperties, typeNameBINARY, INDEXED, MULTIVALUED, OMIT_NORMS, OMIT_POSITIONS, OMIT_TF_POSITIONS, REQUIRED, SORT_MISSING_FIRST, SORT_MISSING_LAST, STORE_TERMOFFSETS, STORE_TERMPOSITIONS, STORE_TERMVECTORS, STORED, TOKENIZED| Constructor and Description |
|---|
ExternalFileField() |
| Modifier and Type | Method and Description |
|---|---|
SortField |
getSortField(SchemaField field,
boolean reverse)
Returns the SortField instance that should be used to sort fields
of this type.
|
ValueSource |
getValueSource(SchemaField field,
QParser parser)
called to get the default value source (normally, from the
Lucene FieldCache.)
|
protected void |
init(IndexSchema schema,
Map<String,String> args)
subclasses should initialize themselves with the args provided
and remove valid arguments.
|
void |
write(TextResponseWriter writer,
String name,
Fieldable f)
calls back to TextResponseWriter to write the field value
|
void |
write(XMLWriter xmlWriter,
String name,
Fieldable f)
Renders the specified field as XML
|
createField, createField, createFields, getAnalyzer, getArg, getFieldIndex, getFieldQuery, getFieldStore, getFieldTermVec, getIndexOptions, getQueryAnalyzer, getRangeQuery, getStringSort, getTypeName, getValueSource, hasProperty, indexedToReadable, isMultiValued, isPolyField, isTokenized, multiValuedFieldCache, readableToIndexed, restrictProps, setAnalyzer, setQueryAnalyzer, storedToIndexed, storedToReadable, toExternal, toInternal, toObject, toStringprotected void init(IndexSchema schema, Map<String,String> args)
FieldTypepublic void write(XMLWriter xmlWriter, String name, Fieldable f) throws IOException
FieldTypewrite in class FieldTypeIOExceptionpublic void write(TextResponseWriter writer, String name, Fieldable f) throws IOException
FieldTypewrite in class FieldTypeIOExceptionpublic SortField getSortField(SchemaField field, boolean reverse)
FieldTypegetSortField in class FieldTypeSchemaField.checkSortability()public ValueSource getValueSource(SchemaField field, QParser parser)
FieldTypegetValueSource in class FieldType