Package com.yahoo.document.serialization

Class VespaDocumentSerializer6

java.lang.Object

com.yahoo.vespa.objects.BufferSerializer

com.yahoo.document.serialization.VespaDocumentSerializer6

All Implemented Interfaces:

AnnotationWriter, DocumentSerializer, DocumentUpdateWriter, DocumentWriter, FieldWriter, SpanNodeWriter, SpanTreeWriter, com.yahoo.vespa.objects.Deserializer, com.yahoo.vespa.objects.Serializer

Direct Known Subclasses:

VespaDocumentSerializerHead

public class VespaDocumentSerializer6
extends com.yahoo.vespa.objects.BufferSerializer
implements DocumentSerializer

Class used for serializing documents on the Vespa 6.x document format.

Author:

baldersheim

Field Summary

Fields inherited from class com.yahoo.vespa.objects.BufferSerializer

buf

Method Summary

Modifier and Type	Method	Description
static long	getSerializedSize(Document doc)	Returns the serialized size of the given Document.
void	write(AlternateSpanList altSpanList)
void	write(Annotation annotation)
void	write(Span span)
void	write(SpanList spanList)
void	write(SpanNode spanNode)
void	write(SpanTree tree)
void	write(Document doc)	Writes a document.
void	write(DocumentId id)
void	write(DocumentRemove documentRemove)
void	write(DocumentType type)
void	write(DocumentUpdate update)
void	write(AddFieldPathUpdate update)
void	write(AssignFieldPathUpdate update)
void	write(FieldPathUpdate update)
void	write(AddValueUpdate update, DataType superType)
void	write(ArithmeticValueUpdate update)
void	write(AssignValueUpdate update, DataType superType)
void	write(ClearValueUpdate clearValueUpdate, DataType superType)
void	write(FieldUpdate update)
void	write(MapValueUpdate update, DataType superType)
void	write(RemoveValueUpdate update, DataType superType)
void	write(TensorAddUpdate update)
void	write(TensorModifyUpdate update)
void	write(TensorRemoveUpdate update)
void	write(com.yahoo.vespa.objects.FieldBase field, AnnotationReference value)	Writes the value of an annotation reference.
<T extends FieldValue> void	write(com.yahoo.vespa.objects.FieldBase field, Array<T> array)	Write out the value of array field
void	write(com.yahoo.vespa.objects.FieldBase field, BoolFieldValue value)	Writes the value of byte field.
void	write(com.yahoo.vespa.objects.FieldBase field, ByteFieldValue value)	Write out the value of byte field
<T extends FieldValue> void	write(com.yahoo.vespa.objects.FieldBase field, CollectionFieldValue<T> value)	Write out the value of collection field
void	write(com.yahoo.vespa.objects.FieldBase field, DoubleFieldValue value)	Write out the value of double field
void	write(com.yahoo.vespa.objects.FieldBase field, FieldValue value)	Write out the value of field
void	write(com.yahoo.vespa.objects.FieldBase field, FloatFieldValue value)	Write out the value of float field
void	write(com.yahoo.vespa.objects.FieldBase field, IntegerFieldValue value)	Write out the value of integer field
void	write(com.yahoo.vespa.objects.FieldBase field, LongFieldValue value)	Write out the value of long field
<K extends FieldValue, V extends FieldValue> void	write(com.yahoo.vespa.objects.FieldBase field, MapFieldValue<K,V> map)	Writes the value of a map field.
void	write(com.yahoo.vespa.objects.FieldBase field, PredicateFieldValue value)	Writes the value of a predicate field.
void	write(com.yahoo.vespa.objects.FieldBase field, Raw value)	Write out the value of raw field
void	write(com.yahoo.vespa.objects.FieldBase field, ReferenceFieldValue value)	Writes the value of a reference field.
void	write(com.yahoo.vespa.objects.FieldBase field, StringFieldValue value)	Write out the value of string field
void	write(com.yahoo.vespa.objects.FieldBase field, Struct value)	Write out the value of struct field
void	write(com.yahoo.vespa.objects.FieldBase field, StructuredFieldValue s)	Write out the value of structured field
void	write(com.yahoo.vespa.objects.FieldBase field, TensorFieldValue value)	Writes the value of a tensor field.
<T extends FieldValue> void	write(com.yahoo.vespa.objects.FieldBase field, WeightedSet<T> ws)	Write out the value of weighted set field
void	write(com.yahoo.vespa.objects.FieldBase field, Document doc)	Writes the value of a field.

Methods inherited from class com.yahoo.vespa.objects.BufferSerializer

createUTF8CharArray, flip, getBuf, getByte, getBytes, getDouble, getFloat, getInt, getInt1_2_4Bytes, getInt1_4Bytes, getInt2_4_8Bytes, getLong, getShort, getString, order, order, position, position, put, put, put, putByte, putDouble, putFloat, putInt, putInt1_4Bytes, putInt2_4_8Bytes, putLong, putShort, remaining, setBuf, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yahoo.document.serialization.DocumentSerializer

getBuf

Methods inherited from interface com.yahoo.vespa.objects.Serializer

put, put, put, putByte, putDouble, putFloat, putInt, putLong, putShort

Method Details

write

public void write(Document doc)

Description copied from interface: DocumentWriter

Writes a document.

Specified by:

write in interface DocumentWriter

write

public void write(com.yahoo.vespa.objects.FieldBase field,
 Document doc)

Description copied from interface: FieldWriter

Writes the value of a field.

Specified by:

write in interface FieldWriter

write

public void write(com.yahoo.vespa.objects.FieldBase field,
 FieldValue value)

Write out the value of field

Specified by:

write in interface FieldWriter

Parameters:

field - - field description (name and data type)

value - - field value

write

public <T extends FieldValue> void write(com.yahoo.vespa.objects.FieldBase field,
 Array<T> array)

Write out the value of array field

Specified by:

write in interface FieldWriter

Parameters:

field - - field description (name and data type)

array - - field value

write

public <K extends FieldValue,
V extends FieldValue>
void write(com.yahoo.vespa.objects.FieldBase field,
 MapFieldValue<K,V> map)

Description copied from interface: FieldWriter

Writes the value of a map field.

Specified by:

write in interface FieldWriter

write

public void write(com.yahoo.vespa.objects.FieldBase field,
 ByteFieldValue value)

Write out the value of byte field

Specified by:

write in interface FieldWriter

Parameters:

field - - field description (name and data type)

value - - field value

write

public void write(com.yahoo.vespa.objects.FieldBase field,
 BoolFieldValue value)

Description copied from interface: FieldWriter

Writes the value of byte field.

Specified by:

write in interface FieldWriter

write

public <T extends FieldValue> void write(com.yahoo.vespa.objects.FieldBase field,
 CollectionFieldValue<T> value)

Write out the value of collection field

Specified by:

write in interface FieldWriter

Parameters:

field - - field description (name and data type)

value - - field value

write

public void write(com.yahoo.vespa.objects.FieldBase field,
 DoubleFieldValue value)

Write out the value of double field

Specified by:

write in interface FieldWriter

Parameters:

field - - field description (name and data type)

value - - field value

write

public void write(com.yahoo.vespa.objects.FieldBase field,
 FloatFieldValue value)

Write out the value of float field

Specified by:

write in interface FieldWriter

Parameters:

field - - field description (name and data type)

value - - field value

write

public void write(com.yahoo.vespa.objects.FieldBase field,
 IntegerFieldValue value)

Write out the value of integer field

Specified by:

write in interface FieldWriter

Parameters:

field - - field description (name and data type)

value - - field value

write

public void write(com.yahoo.vespa.objects.FieldBase field,
 LongFieldValue value)

Write out the value of long field

Specified by:

write in interface FieldWriter

Parameters:

field - - field description (name and data type)

value - - field value

write

public void write(com.yahoo.vespa.objects.FieldBase field,
 Raw value)

Write out the value of raw field

Specified by:

write in interface FieldWriter

Parameters:

field - - field description (name and data type)

value - - field value

write

public void write(com.yahoo.vespa.objects.FieldBase field,
 PredicateFieldValue value)

Description copied from interface: FieldWriter

Writes the value of a predicate field.

Specified by:

write in interface FieldWriter

write

public void write(com.yahoo.vespa.objects.FieldBase field,
 StringFieldValue value)

Write out the value of string field

Specified by:

write in interface FieldWriter

Parameters:

field - - field description (name and data type)

value - - field value

write

public void write(com.yahoo.vespa.objects.FieldBase field,
 TensorFieldValue value)

Description copied from interface: FieldWriter

Writes the value of a tensor field.

Specified by:

write in interface FieldWriter

write

public void write(com.yahoo.vespa.objects.FieldBase field,
 ReferenceFieldValue value)

Description copied from interface: FieldWriter

Writes the value of a reference field.

Specified by:

write in interface FieldWriter

write

public void write(com.yahoo.vespa.objects.FieldBase field,
 StructuredFieldValue s)

Write out the value of structured field

Specified by:

write in interface FieldWriter

Parameters:

field - - field description (name and data type)

s - - field value

write

public void write(com.yahoo.vespa.objects.FieldBase field,
 Struct value)

Write out the value of struct field

Specified by:

write in interface FieldWriter

Parameters:

field - - field description (name and data type)

value - - field value

write

public <T extends FieldValue> void write(com.yahoo.vespa.objects.FieldBase field,
 WeightedSet<T> ws)

Write out the value of weighted set field

Specified by:

write in interface FieldWriter

Parameters:

field - - field description (name and data type)

ws - - field value

write

public void write(com.yahoo.vespa.objects.FieldBase field,
 AnnotationReference value)

Description copied from interface: FieldWriter

Writes the value of an annotation reference.

Specified by:

write in interface FieldWriter

write

public void write(DocumentId id)

Specified by:

write in interface DocumentWriter

write

public void write(DocumentType type)

Specified by:

write in interface DocumentWriter

write

public void write(DocumentRemove documentRemove)

Specified by:

write in interface DocumentWriter

write

public void write(Annotation annotation)

Specified by:

write in interface AnnotationWriter

write

public void write(SpanTree tree)

Specified by:

write in interface SpanTreeWriter

write

public void write(SpanNode spanNode)

Specified by:

write in interface SpanNodeWriter

write

public void write(Span span)

Specified by:

write in interface SpanNodeWriter

write

public void write(SpanList spanList)

Specified by:

write in interface SpanNodeWriter

write

public void write(AlternateSpanList altSpanList)

Specified by:

write in interface SpanNodeWriter

write

public void write(DocumentUpdate update)

Specified by:

write in interface DocumentUpdateWriter

Specified by:

write in interface DocumentWriter

write

public void write(FieldPathUpdate update)

write

public void write(AssignFieldPathUpdate update)

write

public void write(AddFieldPathUpdate update)

write

public void write(FieldUpdate update)

Specified by:

write in interface DocumentUpdateWriter

write

public void write(AddValueUpdate update,
 DataType superType)

Specified by:

write in interface DocumentUpdateWriter

write

public void write(MapValueUpdate update,
 DataType superType)

Specified by:

write in interface DocumentUpdateWriter

write

public void write(ArithmeticValueUpdate update)

Specified by:

write in interface DocumentUpdateWriter

write

public void write(AssignValueUpdate update,
 DataType superType)

Specified by:

write in interface DocumentUpdateWriter

write

public void write(RemoveValueUpdate update,
 DataType superType)

Specified by:

write in interface DocumentUpdateWriter

write

public void write(ClearValueUpdate clearValueUpdate,
 DataType superType)

Specified by:

write in interface DocumentUpdateWriter

write

public void write(TensorModifyUpdate update)

Specified by:

write in interface DocumentUpdateWriter

write

public void write(TensorAddUpdate update)

Specified by:

write in interface DocumentUpdateWriter

write

public void write(TensorRemoveUpdate update)

Specified by:

write in interface DocumentUpdateWriter

getSerializedSize

public static long getSerializedSize(Document doc)

Returns the serialized size of the given Document. Please note that this method performs actual serialization of the document, but simply return the size of the final GrowableByteBuffer. If you need the buffer itself, do NOT use this method.

Parameters:

doc - The Document whose size to calculate.

Returns:

The size in bytes.