Uses of Class
com.yahoo.document.Field
Package
Description
Provides classes and interfaces for creating trees of spans over string
values in Vespa documents, and annotating these spans.
Infrastructure for building Vespa documents and feed operations from JSON.
-
Uses of Field in com.yahoo.document
Modifier and TypeClassDescriptionclass
This adds an Extractor to the Field that can be used to access the backed value used in the concrete document types.class
This adds an Extractor to the ExtendedField that can be used to get access the backed spantrees used in the concrete document types.Modifier and TypeMethodDescriptionAdds a new field to this document type and returns the new field objectBaseStructDataType.getField
(int id) DocumentType.getField
(int id) Gets the field matching a given name.StructDataType.getField
(int id) abstract Field
StructuredDataType.getField
(int id) Gets the field with the specified id.abstract Field
Gets the field matching a given name.FieldPathEntry.getFieldRef()
BaseStructDataType.removeField
(String fieldName) DocumentType.removeField
(String name) Removes an field from the DocumentType.Modifier and TypeMethodDescriptionDocumentType.fieldIteratorThisTypeOnly()
Returns an iterator over all fields in this documenttypeDocumentType.fieldSet()
Returns an ordered set snapshot of all fields of this documenttype, except the fields of Document.DocumentType.fieldSetAll()
This is identical toDocumentType.fieldSet()
fieldSet}, but in addition extra hidden synthetic fields are returned.BaseStructDataType.getFields()
DocumentType.getFields()
All fields defined in the document and its parents This is for internal use UseDocumentType.fieldSet()
instead orDocumentType.fieldSetAll()
if you really want all fieldsStructDataType.getFields()
abstract Collection<Field>
StructuredDataType.getFields()
StructDataType.getFieldsThisTypeOnly()
Document.iterator()
Modifier and TypeMethodDescriptionvoid
void
Adds an field that can be used with this document type.void
int
void
Document.deserialize
(Field field, FieldReader reader) protected void
Document.doSetFieldValue
(Field field, FieldValue value) static Object
SimpleDocument.get
(StructuredFieldValue struct, Field field) final Object
DocumentUpdate.getFieldUpdate
(Field field) Returns the update for a fieldDocument.getFieldValue
(Field field) boolean
static FieldPathEntry
FieldPathEntry.newStructFieldEntry
(Field fieldRef) Creates a new field path entry that references a struct field.static Object
SimpleDocument.remove
(StructuredFieldValue struct, Field field) final Object
DocumentUpdate.removeFieldUpdate
(Field field) Document.removeFieldValue
(Field field) void
Document.serialize
(Field field, FieldWriter writer) static Object
SimpleDocument.set
(StructuredFieldValue struct, Field field, Object value) final Object
-
Uses of Field in com.yahoo.document.annotation
Modifier and TypeMethodDescriptionvoid
AnnotationReference.deserialize
(Field field, FieldReader reader) void
AnnotationReference.serialize
(Field field, FieldWriter writer) -
Uses of Field in com.yahoo.document.datatypes
Modifier and TypeMethodDescriptionabstract Field
Returns the named field object, or null if that field does not exist.Modifier and TypeMethodDescriptionStruct.getFields()
Struct.iterator()
abstract Iterator<Map.Entry<Field,
FieldValue>> StructuredFieldValue.iterator()
Modifier and TypeMethodDescriptionvoid
Array.deserialize
(Field field, FieldReader reader) void
BoolFieldValue.deserialize
(Field field, FieldReader reader) void
ByteFieldValue.deserialize
(Field field, FieldReader reader) void
DoubleFieldValue.deserialize
(Field field, FieldReader reader) abstract void
FieldValue.deserialize
(Field field, FieldReader reader) Read a field value from the specified readervoid
Float16FieldValue.deserialize
(Field field, FieldReader reader) void
FloatFieldValue.deserialize
(Field field, FieldReader reader) void
IntegerFieldValue.deserialize
(Field field, FieldReader reader) void
LongFieldValue.deserialize
(Field field, FieldReader reader) void
MapFieldValue.deserialize
(Field field, FieldReader reader) void
PredicateFieldValue.deserialize
(Field field, FieldReader reader) void
Raw.deserialize
(Field field, FieldReader reader) void
ReferenceFieldValue.deserialize
(Field field, FieldReader reader) void
StringFieldValue.deserialize
(Field field, FieldReader reader) void
Struct.deserialize
(Field field, FieldReader reader) void
TensorFieldValue.deserialize
(Field field, FieldReader reader) void
UriFieldValue.deserialize
(Field field, FieldReader reader) void
WeightedSet.deserialize
(Field field, FieldReader reader) protected void
Struct.doSetFieldValue
(Field field, FieldValue value) protected abstract void
StructuredFieldValue.doSetFieldValue
(Field field, FieldValue value) static <T> T
Struct.getFieldValue
(FieldValue struct, DataType structType, Field field, Class<T> fieldType) Struct.getFieldValue
(Field field) abstract FieldValue
StructuredFieldValue.getFieldValue
(Field field) Returns the value of the given field.Struct.removeFieldValue
(Field field) abstract FieldValue
StructuredFieldValue.removeFieldValue
(Field field) Removes and returns a field value.void
Array.serialize
(Field field, FieldWriter writer) void
BoolFieldValue.serialize
(Field field, FieldWriter writer) void
ByteFieldValue.serialize
(Field field, FieldWriter writer) void
DoubleFieldValue.serialize
(Field field, FieldWriter writer) abstract void
FieldValue.serialize
(Field field, FieldWriter writer) Write out field value to the specified writervoid
Float16FieldValue.serialize
(Field field, FieldWriter writer) void
FloatFieldValue.serialize
(Field field, FieldWriter writer) void
IntegerFieldValue.serialize
(Field field, FieldWriter writer) void
LongFieldValue.serialize
(Field field, FieldWriter writer) void
MapFieldValue.serialize
(Field field, FieldWriter writer) void
PredicateFieldValue.serialize
(Field field, FieldWriter writer) void
Raw.serialize
(Field field, FieldWriter writer) void
ReferenceFieldValue.serialize
(Field field, FieldWriter writer) void
StringFieldValue.serialize
(Field field, FieldWriter writer) void
Struct.serialize
(Field field, FieldWriter writer) void
TensorFieldValue.serialize
(Field field, FieldWriter writer) void
WeightedSet.serialize
(Field field, FieldWriter writer) StructuredFieldValue.setFieldValue
(Field field, FieldValue value) Sets the value of the given field.final FieldValue
StructuredFieldValue.setFieldValue
(Field field, Byte value) final FieldValue
StructuredFieldValue.setFieldValue
(Field field, Double value) final FieldValue
StructuredFieldValue.setFieldValue
(Field field, Integer value) final FieldValue
StructuredFieldValue.setFieldValue
(Field field, Long value) final FieldValue
StructuredFieldValue.setFieldValue
(Field field, String value) -
Uses of Field in com.yahoo.document.json
ModifierConstructorDescriptionJsonReaderException
(DocumentId docId, Field field, Throwable cause) JsonReaderException
(Field field, Throwable cause) -
Uses of Field in com.yahoo.document.json.readers
Modifier and TypeMethodDescriptionstatic void
AddRemoveCreator.createAdds
(TokenBuffer buffer, Field field, FieldUpdate update, boolean ignoreUndefinedFields) static ValueUpdate
MapReader.createMapUpdate
(TokenBuffer buffer, Field field, boolean ignoreUndefinedFields) static TensorModifyUpdate
TensorModifyUpdateReader.createModifyUpdate
(TokenBuffer buffer, Field field) static void
AddRemoveCreator.createRemoves
(TokenBuffer buffer, Field field, FieldUpdate update, boolean ignoreUndefinedFields) static TensorAddUpdate
TensorAddUpdateReader.createTensorAddUpdate
(TokenBuffer buffer, Field field) static boolean
TensorAddUpdateReader.isTensorField
(Field field) -
Uses of Field in com.yahoo.document.update
Modifier and TypeMethodDescriptionFieldUpdate.getField()
Returns the field that this field update applies toModifier and TypeMethodDescriptionstatic FieldUpdate
Creates a new, empty field update with no encapsulated value updates.static FieldUpdate
FieldUpdate.createAdd
(Field field, FieldValue value) Creates a new field update, with one encapsulated value update specifying an addition of a value to an array or a key to a weighted set (with default weight 1).static FieldUpdate
FieldUpdate.createAdd
(Field field, FieldValue key, Integer weight) Creates a new field update, with one encapsulated value update specifying an addition of a key (with a specified weight) to a weighted set.static FieldUpdate
FieldUpdate.createAddAll
(Field field, WeightedSet<? extends FieldValue> set) Creates a new field update, with encapsulated value updates, specifying an addition of all key/weight pairs in a weighted set to a weighted set.static FieldUpdate
FieldUpdate.createAddAll
(Field field, List<? extends FieldValue> values) Creates a new field update, with encapsulated value updates, specifying an addition of all values in a given list to an array.static FieldUpdate
FieldUpdate.createAssign
(Field field, FieldValue newValue) Creates a new field update, with one encapsulated value update, that assigns a new value, completely overwriting the previous value.static FieldUpdate
FieldUpdate.createClear
(Field field) Creates a new field update, with one encapsulated value update, that clears the value; see documentation for ClearValueUpdate to see behavior for the individual data types.static FieldUpdate
FieldUpdate.createClearField
(Field field) Creates a new field update that clears the field.static FieldUpdate
FieldUpdate.createDecrement
(Field field, FieldValue key, Number decrement) Creates a new field update, with one encapsulated value update that decrements a weight in a weighted set.static FieldUpdate
FieldUpdate.createDecrement
(Field field, Number decrement) Creates a new field update, with one encapsulated value update that decrements a value.static FieldUpdate
FieldUpdate.createDivide
(Field field, FieldValue key, Number divisor) Creates a new field update, with one encapsulated value update that divides a weight in a weighted set.static FieldUpdate
FieldUpdate.createDivide
(Field field, Number divisor) Creates a new field update, with one encapsulated value update that divides a value.static FieldUpdate
FieldUpdate.createIncrement
(Field field, FieldValue key, Number increment) Creates a new field update, with one encapsulated value update that increments a weight in a weighted set.static FieldUpdate
FieldUpdate.createIncrement
(Field field, Number increment) Creates a new field update, with one encapsulated value update that increments a value.static FieldUpdate
FieldUpdate.createMap
(Field field, FieldValue value, ValueUpdate update) Creates a new field update, with one encapsulated value update, which is able to map an update to a value to a subvalue in an array or a weighted set.static FieldUpdate
FieldUpdate.createMultiply
(Field field, FieldValue key, Number factor) Creates a new field update, with one encapsulated value update that multiplies a weight in a weighted set.static FieldUpdate
FieldUpdate.createMultiply
(Field field, Number factor) Creates a new field update, with one encapsulated value update that multiplies a value.static FieldUpdate
FieldUpdate.createRemove
(Field field, FieldValue value) Creates a new field update, with one encapsulated value update, specifying the removal of a value from an array or a key/weight from a weighted set.static FieldUpdate
FieldUpdate.createRemoveAll
(Field field, WeightedSet<? extends FieldValue> values) Creates a new field update, with encapsulated value updates, specifying the removal of all values in a given list from an array or weighted set.static FieldUpdate
FieldUpdate.createRemoveAll
(Field field, List<? extends FieldValue> values) Creates a new field update, with encapsulated value updates, specifying the removal of all values in a given list from an array or weighted set.void
Sets the field this update applies to.