org.ojai.base

Class DocumentBase

java.lang.Object

org.ojai.base.DocumentBase

All Implemented Interfaces:

Iterable<Map.Entry<String,Value>>, Container, Document, JsonString

@API.Public
public abstract class DocumentBase
extends Object
implements Document

A template abstract class that implements the Document interface.

Constructor Summary

Constructors

Constructor and Description
DocumentBase()

Method Summary

Modifier and Type	Method and Description
DocumentReader	asReader(String fieldPath)
Document	delete(String fieldPath) Deletes the value at the specified FieldPath if it exists.
ByteBuffer	getBinary(String fieldPath) Returns the value at the specified fieldPath as a ByteBuffer object or null if the specified FieldPath does not exist in the document.
boolean	getBoolean(String fieldPath) Returns the value at the specified fieldPath as a boolean.
Boolean	getBooleanObj(String fieldPath) Returns the value at the specified fieldPath as a Boolean object or null if the specified FieldPath does not exist in the document.
byte	getByte(String fieldPath) Returns the value at the specified fieldPath as a byte.
Byte	getByteObj(String fieldPath) Returns the value at the specified fieldPath as a Byte object or null if the specified FieldPath does not exist in the document.
ODate	getDate(String fieldPath) Returns the value at the specified fieldPath as a ODate object or null if the specified FieldPath does not exist in the document.
BigDecimal	getDecimal(String fieldPath) Returns the value at the specified fieldPath as a BigDecimal object or null if the specified FieldPath does not exist in the document.
double	getDouble(String fieldPath) Returns the value at the specified fieldPath as a double.
Double	getDoubleObj(String fieldPath) Returns the value at the specified fieldPath as a Double object or null if the specified FieldPath does not exist in the document.
float	getFloat(String fieldPath) Returns the value at the specified fieldPath as a float.
Float	getFloatObj(String fieldPath) Returns the value at the specified fieldPath as a Float object or null if the specified FieldPath does not exist in the document.
int	getInt(String fieldPath) Returns the value at the specified fieldPath as an int.
OInterval	getInterval(String fieldPath) Returns the value at the specified fieldPath as an OInterval object or null if the specified FieldPath does not exist in the document.
Integer	getIntObj(String fieldPath) Returns the value at the specified fieldPath as an Integer object or null if the specified FieldPath does not exist in the document.
List<Object>	getList(String fieldPath) Returns the value at the specified fieldPath as a List object or null if the specified FieldPath does not exist in the document.
long	getLong(String fieldPath) Returns the value at the specified fieldPath as a long.
Long	getLongObj(String fieldPath) Returns the value at the specified fieldPath as a Long object or null if the specified FieldPath does not exist in the document.
Map<String,Object>	getMap(String fieldPath) Returns the value at the specified fieldPath as a Map object or null if the specified FieldPath does not exist in the document.
short	getShort(String fieldPath) Returns the value at the specified fieldPath as a short.
Short	getShortObj(String fieldPath) Returns the value at the specified fieldPath as a Short object or null if the specified FieldPath does not exist in the document.
String	getString(String fieldPath) Returns the value at the specified fieldPath as a String object or null if the specified FieldPath does not exist in the document.
OTime	getTime(String fieldPath) Returns the value at the specified fieldPath as a OTime object or null if the specified FieldPath does not exist in the document.
OTimestamp	getTimestamp(String fieldPath) Returns the value at the specified fieldPath as a OTimestamp object or null if the specified FieldPath does not exist in the document.
Value	getValue(String fieldPath) Returns the value at the specified fieldPath as a Value object or null if the specified FieldPath does not exist in the document.
Document	set(String fieldPath, BigDecimal value) Sets the value of the specified fieldPath in this Document to the specified BigDecimal.
Document	set(String fieldPath, boolean value) Sets the value of the specified fieldPath in this Document to the specified boolean value.
Document	set(String fieldPath, byte value) Sets the value of the specified fieldPath in this Document to the specified byte value.
Document	set(String fieldPath, byte[] value) Sets the value of the specified fieldPath in this Document to the specified binary value.
Document	set(String fieldPath, byte[] value, int off, int len) Sets the value of the specified fieldPath in this Document to the specified binary value.
Document	set(String fieldPath, ByteBuffer value) Sets the value of the specified fieldPath in this Document to the specified ByteBuffer.
Document	set(String fieldPath, Document value) Sets the value of the specified fieldPath in this Document to the specified Document.
Document	set(String fieldPath, double value) Sets the value of the specified fieldPath in this Document to the specified double value.
Document	set(String fieldPath, float value) Sets the value of the specified fieldPath in this Document to the specified float value.
Document	set(String fieldPath, int value) Sets the value of the specified fieldPath in this Document to the specified int value.
Document	set(String fieldPath, List<? extends Object> value) Sets the value of the specified fieldPath in this Document to the specified Object List.
Document	set(String fieldPath, long value) Sets the value of the specified fieldPath in this Document to the specified long value.
Document	set(String fieldPath, Map<String,? extends Object> value) Sets the value of the specified fieldPath in this Document to the specified Map.
Document	set(String fieldPath, ODate value) Sets the value of the specified fieldPath in this Document to the specified Date.
Document	set(String fieldPath, OInterval value) Sets the value of the specified fieldPath in this Document to the specified Interval.
Document	set(String fieldPath, OTime value) Sets the value of the specified fieldPath in this Document to the specified Time.
Document	set(String fieldPath, OTimestamp value) Sets the value of the specified fieldPath in this Document to the specified Timestamp.
Document	set(String fieldPath, short value) Sets the value of the specified fieldPath in this Document to the specified short value.
Document	set(String fieldPath, String value) Sets the value of the specified fieldPath in this Document to the specified String.
Document	set(String fieldPath, Value value) Sets the value of the specified fieldPath in this Document to the specified Value.
Document	setArray(String fieldPath, byte[] values) Sets the value of the specified fieldPath in this Document to the specified byte array.
Document	setArray(String fieldPath, double[] values) Sets the value of the specified fieldPath in this Document to the specified double array.
Document	setArray(String fieldPath, float[] values) Sets the value of the specified fieldPath in this Document to the specified float array.
Document	setArray(String fieldPath, int[] values) Sets the value of the specified fieldPath in this Document to the specified int array.
Document	setArray(String fieldPath, long[] values) Sets the value of the specified fieldPath in this Document to the specified long array.
Document	setArray(String fieldPath, Object... value) Sets the value of the specified fieldPath in this Document to the specified Object array.
Document	setArray(String fieldPath, short[] values) Sets the value of the specified fieldPath in this Document to the specified short array.
Document	setArray(String fieldPath, String[] values) Sets the value of the specified fieldPath in this Document to the specified String array.
Document	setNull(String fieldPath) Sets the value of the specified fieldPath in this Document to Value.Type.NULL.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ojai.Document

asMap, asReader, asReader, delete, empty, getBinary, getBoolean, getBooleanObj, getByte, getByteObj, getDate, getDecimal, getDouble, getDoubleObj, getFloat, getFloatObj, getId, getIdBinary, getIdString, getInt, getInterval, getIntObj, getList, getLong, getLongObj, getMap, getShort, getShortObj, getString, getTime, getTimestamp, getValue, isReadOnly, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, set, setArray, setArray, setArray, setArray, setArray, setArray, setArray, setArray, setArray, setArray, setId, setId, setId, setNull, size, toJavaBean, toString

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.ojai.Container

isEmpty

Methods inherited from interface org.ojai.JsonString

asJsonString, asJsonString

Constructor Detail

DocumentBase

public DocumentBase()

Method Detail

set

public Document set(String fieldPath,
                    String value)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified String.

Specified by:

set in interface Document

Parameters:

fieldPath - the FieldPath to set

value - the String value

Returns:

this for chaining

set

public Document set(String fieldPath,
                    boolean value)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified boolean value.

Specified by:

set in interface Document

Parameters:

fieldPath - the FieldPath to set

value - the boolean value

Returns:

this for chaining

set

public Document set(String fieldPath,
                    byte value)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified byte value.

Specified by:

set in interface Document

Parameters:

fieldPath - the FieldPath to set

value - the byte value

Returns:

this for chaining

set

public Document set(String fieldPath,
                    short value)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified short value.

Specified by:

set in interface Document

Parameters:

fieldPath - the FieldPath to set

value - the short value

Returns:

this for chaining

set

public Document set(String fieldPath,
                    int value)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified int value.

Specified by:

set in interface Document

Parameters:

fieldPath - the FieldPath to set

value - the int value

Returns:

this for chaining

set

public Document set(String fieldPath,
                    long value)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified long value.

Specified by:

set in interface Document

Parameters:

fieldPath - the FieldPath to set

value - the long value

Returns:

this for chaining

set

public Document set(String fieldPath,
                    float value)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified float value.

Specified by:

set in interface Document

Parameters:

fieldPath - the FieldPath to set

value - the float value

Returns:

this for chaining

set

public Document set(String fieldPath,
                    double value)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified double value.

Specified by:

set in interface Document

Parameters:

fieldPath - the FieldPath to set

value - the double value

Returns:

this for chaining

set

public Document set(String fieldPath,
                    OTime value)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified Time.

Specified by:

set in interface Document

Parameters:

fieldPath - the FieldPath to set

value - the Time value

Returns:

this for chaining

set

public Document set(String fieldPath,
                    ODate value)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified Date.

Specified by:

set in interface Document

Parameters:

fieldPath - the FieldPath to set

value - the Date value

Returns:

this for chaining

set

public Document set(String fieldPath,
                    OTimestamp value)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified Timestamp.

Specified by:

set in interface Document

Parameters:

fieldPath - the FieldPath to set

value - the Timestamp value

Returns:

this for chaining

set

public Document set(String fieldPath,
                    BigDecimal value)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified BigDecimal.

Specified by:

set in interface Document

Parameters:

fieldPath - the FieldPath to set

value - the BigDecimal value

Returns:

this for chaining

set

public Document set(String fieldPath,
                    byte[] value)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified binary value.

Specified by:

set in interface Document

Parameters:

fieldPath - the FieldPath to set

value - the byte array containing the binary value

Returns:

this for chaining

set

public Document set(String fieldPath,
                    byte[] value,
                    int off,
                    int len)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified binary value.

Specified by:

set in interface Document

Parameters:

fieldPath - the FieldPath to set

value - the byte array containing the binary value

Returns:

this for chaining

set

public Document set(String fieldPath,
                    ByteBuffer value)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified ByteBuffer.

Specified by:

set in interface Document

Parameters:

fieldPath - the FieldPath to set

value - the ByteBuffer

Returns:

this for chaining

set

public Document set(String fieldPath,
                    OInterval value)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified Interval.

Specified by:

set in interface Document

Parameters:

fieldPath - the FieldPath to set

value - the Interval value

Returns:

this for chaining

set

public Document set(String fieldPath,
                    Map<String,? extends Object> value)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified Map.

Specified by:

set in interface Document

Parameters:

fieldPath - the FieldPath to set

value - the Map value

Returns:

this for chaining

set

public Document set(String fieldPath,
                    Document value)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified Document. Recursive set such as set("a", doc) followed by set("a.b", doc) is undefined.

Specified by:

set in interface Document

Parameters:

fieldPath - the FieldPath to set

value - the Document

Returns:

this for chaining

set

public Document set(String fieldPath,
                    Value value)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified Value.

Specified by:

set in interface Document

Parameters:

fieldPath - the FieldPath to set

value - the Value

Returns:

this for chaining

setArray

public Document setArray(String fieldPath,
                         Object... value)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified Object array.

Specified by:

setArray in interface Document

Parameters:

fieldPath - the FieldPath to set

value - the Object array

Returns:

this for chaining

set

public Document set(String fieldPath,
                    List<? extends Object> value)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified Object List.

Specified by:

set in interface Document

Parameters:

fieldPath - the FieldPath to set

value - the Object List

Returns:

this for chaining

delete

public Document delete(String fieldPath)

Description copied from interface: Document

Deletes the value at the specified FieldPath if it exists.

Specified by:

delete in interface Document

Parameters:

fieldPath - the fieldPath to delete from the document

Returns:

this for chaining

getString

public String getString(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as a String object or null if the specified FieldPath does not exist in the document.

Specified by:

getString in interface Document

getBoolean

public boolean getBoolean(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as a boolean.

Specified by:

getBoolean in interface Document

getBooleanObj

public Boolean getBooleanObj(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as a Boolean object or null if the specified FieldPath does not exist in the document.

Specified by:

getBooleanObj in interface Document

getByte

public byte getByte(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as a byte.

Specified by:

getByte in interface Document

getByteObj

public Byte getByteObj(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as a Byte object or null if the specified FieldPath does not exist in the document.

Specified by:

getByteObj in interface Document

getShort

public short getShort(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as a short.

Specified by:

getShort in interface Document

getShortObj

public Short getShortObj(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as a Short object or null if the specified FieldPath does not exist in the document.

Specified by:

getShortObj in interface Document

getInt

public int getInt(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as an int.

Specified by:

getInt in interface Document

getIntObj

public Integer getIntObj(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as an Integer object or null if the specified FieldPath does not exist in the document.

Specified by:

getIntObj in interface Document

getLong

public long getLong(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as a long.

Specified by:

getLong in interface Document

getLongObj

public Long getLongObj(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as a Long object or null if the specified FieldPath does not exist in the document.

Specified by:

getLongObj in interface Document

getFloat

public float getFloat(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as a float.

Specified by:

getFloat in interface Document

getFloatObj

public Float getFloatObj(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as a Float object or null if the specified FieldPath does not exist in the document.

Specified by:

getFloatObj in interface Document

getDouble

public double getDouble(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as a double.

Specified by:

getDouble in interface Document

getDoubleObj

public Double getDoubleObj(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as a Double object or null if the specified FieldPath does not exist in the document.

Specified by:

getDoubleObj in interface Document

getTime

public OTime getTime(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as a OTime object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Specified by:

getTime in interface Document

getDate

public ODate getDate(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as a ODate object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Specified by:

getDate in interface Document

getTimestamp

public OTimestamp getTimestamp(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as a OTimestamp object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Specified by:

getTimestamp in interface Document

getDecimal

public BigDecimal getDecimal(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as a BigDecimal object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Specified by:

getDecimal in interface Document

getBinary

public ByteBuffer getBinary(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as a ByteBuffer object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Specified by:

getBinary in interface Document

getInterval

public OInterval getInterval(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as an OInterval object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Specified by:

getInterval in interface Document

getValue

public Value getValue(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as a Value object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Specified by:

getValue in interface Document

asReader

public DocumentReader asReader(String fieldPath)

Specified by:

asReader in interface Document

Returns:

a new DocumentReader over the node specified by the fieldPath or null if the node does not exist

setArray

public Document setArray(String fieldPath,
                         byte[] values)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified byte array.

Specified by:

setArray in interface Document

Parameters:

fieldPath - the FieldPath to set

values - the byte array

Returns:

this for chaining

setArray

public Document setArray(String fieldPath,
                         short[] values)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified short array.

Specified by:

setArray in interface Document

Parameters:

fieldPath - the FieldPath to set

values - the short array

Returns:

this for chaining

setArray

public Document setArray(String fieldPath,
                         int[] values)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified int array.

Specified by:

setArray in interface Document

Parameters:

fieldPath - the FieldPath to set

values - the int array

Returns:

this for chaining

setArray

public Document setArray(String fieldPath,
                         long[] values)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified long array.

Specified by:

setArray in interface Document

Parameters:

fieldPath - the FieldPath to set

values - the long array

Returns:

this for chaining

setArray

public Document setArray(String fieldPath,
                         float[] values)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified float array.

Specified by:

setArray in interface Document

Parameters:

fieldPath - the FieldPath to set

values - the float array

Returns:

this for chaining

setArray

public Document setArray(String fieldPath,
                         double[] values)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified double array.

Specified by:

setArray in interface Document

Parameters:

fieldPath - the FieldPath to set

values - the double array

Returns:

this for chaining

setArray

public Document setArray(String fieldPath,
                         String[] values)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to the specified String array.

Specified by:

setArray in interface Document

Parameters:

fieldPath - the FieldPath to set

values - the String array

Returns:

this for chaining

setNull

public Document setNull(String fieldPath)

Description copied from interface: Document

Sets the value of the specified fieldPath in this Document to Value.Type.NULL.

Specified by:

setNull in interface Document

Parameters:

fieldPath - the FieldPath to set

Returns:

this for chaining

getMap

public Map<String,Object> getMap(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as a Map object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Specified by:

getMap in interface Document

getList

public List<Object> getList(String fieldPath)

Description copied from interface: Document

Returns the value at the specified fieldPath as a List object or null if the specified FieldPath does not exist in the document. Modifying the returned object does not alter the content of the document.

Specified by:

getList in interface Document