Package com.yahoo.vespaxmlparser

Class VespaXMLFieldReader

java.lang.Object

com.yahoo.vespaxmlparser.VespaXMLReader

com.yahoo.vespaxmlparser.VespaXMLFieldReader

All Implemented Interfaces:

FieldReader, com.yahoo.vespa.objects.Deserializer

Direct Known Subclasses:

VespaXMLDocumentReader, VespaXMLUpdateReader

public class VespaXMLFieldReader
extends VespaXMLReader
implements FieldReader

XML parser that reads document fields from an XML stream. All read methods assume that the stream is currently positioned at the start element of the relevant field.

Constructor Summary

Constructors

Constructor	Description
VespaXMLFieldReader(java.io.InputStream stream, DocumentTypeManager docTypeManager)
VespaXMLFieldReader(java.lang.String fileName, DocumentTypeManager docTypeManager)
VespaXMLFieldReader(javax.xml.stream.XMLStreamReader reader, DocumentTypeManager docTypeManager)

Method Summary

Modifier and Type	Method	Description
byte	getByte(com.yahoo.vespa.objects.FieldBase fieldBase)
byte[]	getBytes(com.yahoo.vespa.objects.FieldBase fieldBase, int i)
java.util.Optional<java.lang.String>	getCondition()
DocumentTypeManager	getDocumentTypeManager()
double	getDouble(com.yahoo.vespa.objects.FieldBase fieldBase)
float	getFloat(com.yahoo.vespa.objects.FieldBase fieldBase)
int	getInt(com.yahoo.vespa.objects.FieldBase fieldBase)
long	getLong(com.yahoo.vespa.objects.FieldBase fieldBase)
short	getShort(com.yahoo.vespa.objects.FieldBase fieldBase)
java.lang.String	getString(com.yahoo.vespa.objects.FieldBase fieldBase)
void	read(com.yahoo.vespa.objects.FieldBase field, AnnotationReference value)	Read in the value of annotation reference.
<T extends FieldValue> void	read(com.yahoo.vespa.objects.FieldBase field, Array<T> value)	Read in the value of array field
void	read(com.yahoo.vespa.objects.FieldBase field, BoolFieldValue value)	Read in the value of byte field
void	read(com.yahoo.vespa.objects.FieldBase field, ByteFieldValue value)	Read in the value of byte field
<T extends FieldValue> void	read(com.yahoo.vespa.objects.FieldBase field, CollectionFieldValue<T> value)	Read in the value of collection field
void	read(com.yahoo.vespa.objects.FieldBase field, DoubleFieldValue value)	Read in the value of double field
void	read(com.yahoo.vespa.objects.FieldBase field, FieldValue value)	Read in the value of field
void	read(com.yahoo.vespa.objects.FieldBase field, FloatFieldValue value)	Read in the value of float field
void	read(com.yahoo.vespa.objects.FieldBase field, IntegerFieldValue value)	Read in the value of integer field
void	read(com.yahoo.vespa.objects.FieldBase field, LongFieldValue value)	Read in the value of long field
<K extends FieldValue,V extends FieldValue> void	read(com.yahoo.vespa.objects.FieldBase field, MapFieldValue<K,V> map)	Read the value of a map field
void	read(com.yahoo.vespa.objects.FieldBase field, PredicateFieldValue value)	Read in the value of predicate field
void	read(com.yahoo.vespa.objects.FieldBase field, Raw value)	Read in the value of raw field
void	read(com.yahoo.vespa.objects.FieldBase field, ReferenceFieldValue value)	Read in the value of the given reference field.
void	read(com.yahoo.vespa.objects.FieldBase field, StringFieldValue value)	Read in the value of string field
void	read(com.yahoo.vespa.objects.FieldBase field, Struct value)	Read in the value of struct field
void	read(com.yahoo.vespa.objects.FieldBase field, StructuredFieldValue value)	Read in the value of structured field
void	read(com.yahoo.vespa.objects.FieldBase field, TensorFieldValue value)	Read in the value of the given tensor field.
<T extends FieldValue> void	read(com.yahoo.vespa.objects.FieldBase field, WeightedSet<T> value)	Read in the value of weighted set field
void	read(com.yahoo.vespa.objects.FieldBase field, Document document)	Read in the value of field
DocumentId	readDocumentId()
DocumentType	readDocumentType()

Methods inherited from class com.yahoo.vespaxmlparser.VespaXMLReader

isBase64EncodedElement, isBase64EncodingAttribute, newDeserializeException, newException, skipToEnd

Methods inherited from class java.lang.Object

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

Constructor Detail

VespaXMLFieldReader

public VespaXMLFieldReader(java.lang.String fileName,
                           DocumentTypeManager docTypeManager)
                    throws java.lang.Exception

Throws:

java.lang.Exception

VespaXMLFieldReader

public VespaXMLFieldReader(java.io.InputStream stream,
                           DocumentTypeManager docTypeManager)
                    throws java.lang.Exception

Throws:

java.lang.Exception

VespaXMLFieldReader

public VespaXMLFieldReader(javax.xml.stream.XMLStreamReader reader,
                           DocumentTypeManager docTypeManager)

Method Detail

getCondition

public java.util.Optional<java.lang.String> getCondition()

read

public void read(com.yahoo.vespa.objects.FieldBase field,
                 Document document)

Description copied from interface: FieldReader

Read in the value of field

Specified by:

read in interface FieldReader

Parameters:

field - - field description (name and data type)

document - - field value

read

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

Description copied from interface: FieldReader

Read in the value of array field

Specified by:

read in interface FieldReader

Parameters:

field - - field description (name and data type)

value - - field value

read

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

Description copied from interface: FieldReader

Read the value of a map field

Specified by:

read in interface FieldReader

read

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

Description copied from interface: FieldReader

Read in the value of struct field

Specified by:

read in interface FieldReader

Parameters:

field - - field description (name and data type)

value - - field value

read

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

Description copied from interface: FieldReader

Read in the value of weighted set field

Specified by:

read in interface FieldReader

Parameters:

field - - field description (name and data type)

value - - field value

read

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

Description copied from interface: FieldReader

Read in the value of byte field

Specified by:

read in interface FieldReader

Parameters:

field - - field description (name and data type)

value - - field value

read

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

Description copied from interface: FieldReader

Read in the value of byte field

Specified by:

read in interface FieldReader

Parameters:

field - - field description (name and data type)

value - - field value

read

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

Description copied from interface: FieldReader

Read in the value of double field

Specified by:

read in interface FieldReader

Parameters:

field - - field description (name and data type)

value - - field value

read

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

Description copied from interface: FieldReader

Read in the value of float field

Specified by:

read in interface FieldReader

Parameters:

field - - field description (name and data type)

value - - field value

read

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

Description copied from interface: FieldReader

Read in the value of integer field

Specified by:

read in interface FieldReader

Parameters:

field - - field description (name and data type)

value - - field value

read

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

Description copied from interface: FieldReader

Read in the value of long field

Specified by:

read in interface FieldReader

Parameters:

field - - field description (name and data type)

value - - field value

read

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

Description copied from interface: FieldReader

Read in the value of raw field

Specified by:

read in interface FieldReader

Parameters:

field - - field description (name and data type)

value - - field value

read

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

Description copied from interface: FieldReader

Read in the value of predicate field

Specified by:

read in interface FieldReader

Parameters:

field - - field description (name and data type)

value - - field value

read

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

Description copied from interface: FieldReader

Read in the value of string field

Specified by:

read in interface FieldReader

Parameters:

field - - field description (name and data type)

value - - field value

read

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

Description copied from interface: FieldReader

Read in the value of the given tensor field.

Specified by:

read in interface FieldReader

Parameters:

field - field description (name and data type)

value - tensor field value

read

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

Description copied from interface: FieldReader

Read in the value of the given reference field.

Specified by:

read in interface FieldReader

Parameters:

field - field description (name and data type)

value - reference field value

read

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

Description copied from interface: FieldReader

Read in the value of annotation reference.

Specified by:

read in interface FieldReader

Parameters:

field - - field description (name and data type)

value - - field value

readDocumentId

public DocumentId readDocumentId()

readDocumentType

public DocumentType readDocumentType()

getDocumentTypeManager

public DocumentTypeManager getDocumentTypeManager()

read

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

Description copied from interface: FieldReader

Read in the value of collection field

Specified by:

read in interface FieldReader

Parameters:

field - - field description (name and data type)

value - - field value

read

public void read(com.yahoo.vespa.objects.FieldBase field,
                 StructuredFieldValue value)

Description copied from interface: FieldReader

Read in the value of structured field

Specified by:

read in interface FieldReader

Parameters:

field - - field description (name and data type)

value - - field value

read

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

Description copied from interface: FieldReader

Read in the value of field

Specified by:

read in interface FieldReader

Parameters:

field - - field description (name and data type)

value - - field value

getByte

public byte getByte(com.yahoo.vespa.objects.FieldBase fieldBase)

Specified by:

getByte in interface com.yahoo.vespa.objects.Deserializer

getShort

public short getShort(com.yahoo.vespa.objects.FieldBase fieldBase)

Specified by:

getShort in interface com.yahoo.vespa.objects.Deserializer

getInt

public int getInt(com.yahoo.vespa.objects.FieldBase fieldBase)

Specified by:

getInt in interface com.yahoo.vespa.objects.Deserializer

getLong

public long getLong(com.yahoo.vespa.objects.FieldBase fieldBase)

Specified by:

getLong in interface com.yahoo.vespa.objects.Deserializer

getFloat

public float getFloat(com.yahoo.vespa.objects.FieldBase fieldBase)

Specified by:

getFloat in interface com.yahoo.vespa.objects.Deserializer

getDouble

public double getDouble(com.yahoo.vespa.objects.FieldBase fieldBase)

Specified by:

getDouble in interface com.yahoo.vespa.objects.Deserializer

getBytes

public byte[] getBytes(com.yahoo.vespa.objects.FieldBase fieldBase,
                       int i)

Specified by:

getBytes in interface com.yahoo.vespa.objects.Deserializer

getString

public java.lang.String getString(com.yahoo.vespa.objects.FieldBase fieldBase)

Specified by:

getString in interface com.yahoo.vespa.objects.Deserializer