Module org.elasticsearch.server
Package org.elasticsearch.index.mapper
Class StringStoredFieldFieldLoader
java.lang.Object
org.elasticsearch.index.mapper.StringStoredFieldFieldLoader
- All Implemented Interfaces:
SourceLoader.SyntheticFieldLoader
public abstract class StringStoredFieldFieldLoader
extends Object
implements SourceLoader.SyntheticFieldLoader
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.index.mapper.SourceLoader.SyntheticFieldLoader
SourceLoader.SyntheticFieldLoader.DocValuesLoader, SourceLoader.SyntheticFieldLoader.StoredFieldLoader -
Field Summary
Fields inherited from interface org.elasticsearch.index.mapper.SourceLoader.SyntheticFieldLoader
NOTHING -
Constructor Summary
ConstructorsConstructorDescriptionStringStoredFieldFieldLoader(String fullName, String simpleName) StringStoredFieldFieldLoader(String storedFieldLoaderName, String fullName, String simpleName) -
Method Summary
Modifier and TypeMethodDescriptiondocValuesLoader(org.apache.lucene.index.LeafReader reader, int[] docIdsInLeaf) Build something to load doc values for this field or returnnullif there are no doc values for this field to load.Returns the canonical field name for this loader.final booleanhasValue()Has this field loaded any values for this document?voidreset()Resets the loader to remove any stored data and prepare it for processing new document.AStreammapping stored field paths to a place to put them so they can be included in the next document.final voidWrite values for this document.protected abstract voidwrite(XContentBuilder b, Object value) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.index.mapper.SourceLoader.SyntheticFieldLoader
prepare, setIgnoredValues
-
Constructor Details
-
StringStoredFieldFieldLoader
-
StringStoredFieldFieldLoader
-
-
Method Details
-
storedFieldLoaders
public final Stream<Map.Entry<String,SourceLoader.SyntheticFieldLoader.StoredFieldLoader>> storedFieldLoaders()Description copied from interface:SourceLoader.SyntheticFieldLoaderAStreammapping stored field paths to a place to put them so they can be included in the next document.- Specified by:
storedFieldLoadersin interfaceSourceLoader.SyntheticFieldLoader
-
hasValue
public final boolean hasValue()Description copied from interface:SourceLoader.SyntheticFieldLoaderHas this field loaded any values for this document?- Specified by:
hasValuein interfaceSourceLoader.SyntheticFieldLoader
-
write
Description copied from interface:SourceLoader.SyntheticFieldLoaderWrite values for this document.- Specified by:
writein interfaceSourceLoader.SyntheticFieldLoader- Throws:
IOException
-
reset
public void reset()Description copied from interface:SourceLoader.SyntheticFieldLoaderResets the loader to remove any stored data and prepare it for processing new document. This is an alternative code path toSourceLoader.SyntheticFieldLoader.write(org.elasticsearch.xcontent.XContentBuilder)that is executed when values are loaded but not written. Loaders are expected to also reset their state after writing currently present data.- Specified by:
resetin interfaceSourceLoader.SyntheticFieldLoader
-
write
- Throws:
IOException
-
docValuesLoader
public final SourceLoader.SyntheticFieldLoader.DocValuesLoader docValuesLoader(org.apache.lucene.index.LeafReader reader, int[] docIdsInLeaf) throws IOException Description copied from interface:SourceLoader.SyntheticFieldLoaderBuild something to load doc values for this field or returnnullif there are no doc values for this field to load.- Specified by:
docValuesLoaderin interfaceSourceLoader.SyntheticFieldLoader- Parameters:
docIdsInLeaf- can be null.- Throws:
IOException
-
fieldName
Description copied from interface:SourceLoader.SyntheticFieldLoaderReturns the canonical field name for this loader.- Specified by:
fieldNamein interfaceSourceLoader.SyntheticFieldLoader
-