org.ojai.util

Class Documents

java.lang.Object

org.ojai.util.Documents

@API.Public
public class Documents
extends Object

This class contains utility methods for Document interface.

Constructor Summary

Constructors

Constructor and Description
Documents()

Method Summary

Modifier and Type	Method and Description
static boolean	equals(Document d1, Document d2) Compares two documents for equality.
static ByteBuffer	getBinary(Document document, FieldPath fieldPath, ByteBuffer defaultValue) Returns the value at the specified fieldPath as a ByteBuffer object or the specified defaultValue if the specified FieldPath does not exist in the document.
static ByteBuffer	getBinary(Document document, String fieldPath, ByteBuffer defaultValue) Returns the value at the specified fieldPath as a ByteBuffer object or the specified defaultValue if the specified FieldPath does not exist in the document.
static boolean	getBoolean(Document document, FieldPath fieldPath, boolean defaultValue) Returns the value at the specified fieldPath as a boolean or the specified defaultValue if the specified FieldPath does not exist in the document.
static boolean	getBoolean(Document document, String fieldPath, boolean defaultValue) Returns the value at the specified fieldPath as a boolean or the specified defaultValue if the specified FieldPath does not exist in the document.
static byte	getByte(Document document, FieldPath fieldPath, byte defaultValue) Returns the value at the specified fieldPath as a byte or the specified defaultValue if the specified FieldPath does not exist in the document.
static byte	getByte(Document document, String fieldPath, byte defaultValue) Returns the value at the specified fieldPath as a byte or the specified defaultValue if the specified FieldPath does not exist in the document.
static ODate	getDate(Document document, FieldPath fieldPath, ODate defaultValue) Returns the value at the specified fieldPath as a ODate or the specified defaultValue if the specified FieldPath does not exist in the document.
static ODate	getDate(Document document, String fieldPath, ODate defaultValue) Returns the value at the specified fieldPath as a ODate or the specified defaultValue if the specified FieldPath does not exist in the document.
static BigDecimal	getDecimal(Document document, FieldPath fieldPath, BigDecimal defaultValue) Returns the value at the specified fieldPath as a BigDecimal or the specified defaultValue if the specified FieldPath does not exist in the document.
static BigDecimal	getDecimal(Document document, String fieldPath, BigDecimal defaultValue) Returns the value at the specified fieldPath as a BigDecimal or the specified defaultValue if the specified FieldPath does not exist in the document.
static double	getDouble(Document document, FieldPath fieldPath, double defaultValue) Returns the value at the specified fieldPath as a double or the specified defaultValue if the specified FieldPath does not exist in the document.
static double	getDouble(Document document, String fieldPath, double defaultValue) Returns the value at the specified fieldPath as a double or the specified defaultValue if the specified FieldPath does not exist in the document.
static float	getFloat(Document document, FieldPath fieldPath, float defaultValue) Returns the value at the specified fieldPath as a float or the specified defaultValue if the specified FieldPath does not exist in the document.
static float	getFloat(Document document, String fieldPath, float defaultValue) Returns the value at the specified fieldPath as a float or the specified defaultValue if the specified FieldPath does not exist in the document.
static int	getInt(Document document, FieldPath fieldPath, int defaultValue) Returns the value at the specified fieldPath as a int or the specified defaultValue if the specified FieldPath does not exist in the document.
static int	getInt(Document document, String fieldPath, int defaultValue) Returns the value at the specified fieldPath as a int or the specified defaultValue if the specified FieldPath does not exist in the document.
static OInterval	getInterval(Document document, FieldPath fieldPath, OInterval defaultValue) Returns the value at the specified fieldPath as a OInterval or the specified defaultValue if the specified FieldPath does not exist in the document.
static OInterval	getInterval(Document document, String fieldPath, OInterval defaultValue) Returns the value at the specified fieldPath as a OInterval or the specified defaultValue if the specified FieldPath does not exist in the document.
static List<Object>	getList(Document document, FieldPath fieldPath, List<Object> defaultValue) Returns the value at the specified fieldPath as a List or the specified defaultValue if the specified FieldPath does not exist in the document.
static List<Object>	getList(Document document, String fieldPath, List<Object> defaultValue) Returns the value at the specified fieldPath as a List or the specified defaultValue if the specified FieldPath does not exist in the document.
static long	getLong(Document document, FieldPath fieldPath, long defaultValue) Returns the value at the specified fieldPath as a long or the specified defaultValue if the specified FieldPath does not exist in the document.
static long	getLong(Document document, String fieldPath, long defaultValue) Returns the value at the specified fieldPath as a long or the specified defaultValue if the specified FieldPath does not exist in the document.
static Map<String,Object>	getMap(Document document, FieldPath fieldPath, Map<String,Object> defaultValue) Returns the value at the specified fieldPath as a Map or the specified defaultValue if the specified FieldPath does not exist in the document.
static Map<String,Object>	getMap(Document document, String fieldPath, Map<String,Object> defaultValue) Returns the value at the specified fieldPath as a Map or the specified defaultValue if the specified FieldPath does not exist in the document.
static short	getShort(Document document, FieldPath fieldPath, short defaultValue) Returns the value at the specified fieldPath as a short or the specified defaultValue if the specified FieldPath does not exist in the document.
static short	getShort(Document document, String fieldPath, short defaultValue) Returns the value at the specified fieldPath as a short or the specified defaultValue if the specified FieldPath does not exist in the document.
static String	getString(Document document, FieldPath fieldPath, String defaultValue) Returns the value at the specified fieldPath as a String or the specified defaultValue if the specified FieldPath does not exist in the document.
static String	getString(Document document, String fieldPath, String defaultValue) Returns the value at the specified fieldPath as a String or the specified defaultValue if the specified FieldPath does not exist in the document.
static OTime	getTime(Document document, FieldPath fieldPath, OTime defaultValue) Returns the value at the specified fieldPath as a OTime or the specified defaultValue if the specified FieldPath does not exist in the document.
static OTime	getTime(Document document, String fieldPath, OTime defaultValue) Returns the value at the specified fieldPath as a OTime or the specified defaultValue if the specified FieldPath does not exist in the document.
static OTimestamp	getTimestamp(Document document, FieldPath fieldPath, OTimestamp defaultValue) Returns the value at the specified fieldPath as a OTimestamp or the specified defaultValue if the specified FieldPath does not exist in the document.
static OTimestamp	getTimestamp(Document document, String fieldPath, OTimestamp defaultValue) Returns the value at the specified fieldPath as a OTimestamp or the specified defaultValue if the specified FieldPath does not exist in the document.
static Value	getValue(Document document, FieldPath fieldPath, Value defaultValue) Returns the value at the specified fieldPath as a Value or the specified defaultValue if the specified FieldPath does not exist in the document.
static Value	getValue(Document document, String fieldPath, Value defaultValue) Returns the value at the specified fieldPath as a Value or the specified defaultValue if the specified FieldPath does not exist in the document.
static Document	readOnly(Document src) Creates and return a read-only view of the specified OJAI document. Any attempt to modify the returned document will result in ReadOnlyObjectException being thrown.
static void	writeReaderToBuilder(DocumentReader reader, DocumentBuilder builder) This method can be used to build a Document (via DocumentBuilder) from a DocumentReader instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

Documents

public Documents()

Method Detail

equals

public static boolean equals(@API.Nullable
                             Document d1,
                             @API.Nullable
                             Document d2)

Compares two documents for equality.

Parameters:

d1 - the first document to compare

d2 - the second document to compare

Returns:

true if both the documents are equal, false otherwise.

readOnly

public static Document readOnly(Document src)

Creates and return a read-only view of the specified OJAI document.

Any attempt to modify the returned document will result in ReadOnlyObjectException being thrown.

Parameters:

src - the source Document

Returns:

a read only view of the specified Document

writeReaderToBuilder

public static void writeReaderToBuilder(@API.NonNullable
                                        DocumentReader reader,
                                        @API.NonNullable
                                        DocumentBuilder builder)

This method can be used to build a Document (via DocumentBuilder) from a DocumentReader instance.

Parameters:

reader - instance of DocumentReader to read the fields from

builder - instance of DocumentBuilder to write the field to

getBinary

public static ByteBuffer getBinary(@API.NonNullable
                                   Document document,
                                   @API.NonNullable
                                   FieldPath fieldPath,
                                   @API.Nullable
                                   ByteBuffer defaultValue)

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

Throws:

TypeException - if the value at the fieldPath is not of BINARY type

getBinary

public static ByteBuffer getBinary(@API.NonNullable
                                   Document document,
                                   @API.NonNullable
                                   String fieldPath,
                                   @API.Nullable
                                   ByteBuffer defaultValue)

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

Throws:

TypeException - if the value at the fieldPath is not of BINARY type

getBoolean

public static boolean getBoolean(@API.NonNullable
                                 Document document,
                                 @API.NonNullable
                                 FieldPath fieldPath,
                                 @API.Nullable
                                 boolean defaultValue)

Returns the value at the specified fieldPath as a boolean or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not of BOOLEAN type

getBoolean

public static boolean getBoolean(@API.NonNullable
                                 Document document,
                                 @API.NonNullable
                                 String fieldPath,
                                 @API.Nullable
                                 boolean defaultValue)

Returns the value at the specified fieldPath as a boolean or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not of BOOLEAN type

getByte

public static byte getByte(@API.NonNullable
                           Document document,
                           @API.NonNullable
                           FieldPath fieldPath,
                           @API.Nullable
                           byte defaultValue)

Returns the value at the specified fieldPath as a byte or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getByte

public static byte getByte(@API.NonNullable
                           Document document,
                           @API.NonNullable
                           String fieldPath,
                           byte defaultValue)

Returns the value at the specified fieldPath as a byte or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getDate

public static ODate getDate(@API.NonNullable
                            Document document,
                            @API.NonNullable
                            FieldPath fieldPath,
                            @API.Nullable
                            ODate defaultValue)

Returns the value at the specified fieldPath as a ODate or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not of the DATE type

getDate

public static ODate getDate(@API.NonNullable
                            Document document,
                            @API.NonNullable
                            String fieldPath,
                            @API.Nullable
                            ODate defaultValue)

Returns the value at the specified fieldPath as a ODate or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not of the DATE type

getDecimal

public static BigDecimal getDecimal(@API.NonNullable
                                    Document document,
                                    @API.NonNullable
                                    FieldPath fieldPath,
                                    @API.Nullable
                                    BigDecimal defaultValue)

Returns the value at the specified fieldPath as a BigDecimal or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getDecimal

public static BigDecimal getDecimal(@API.NonNullable
                                    Document document,
                                    @API.NonNullable
                                    String fieldPath,
                                    @API.Nullable
                                    BigDecimal defaultValue)

Returns the value at the specified fieldPath as a BigDecimal or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getDouble

public static double getDouble(@API.NonNullable
                               Document document,
                               @API.NonNullable
                               FieldPath fieldPath,
                               double defaultValue)

Returns the value at the specified fieldPath as a double or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getDouble

public static double getDouble(@API.NonNullable
                               Document document,
                               @API.NonNullable
                               String fieldPath,
                               @API.Nullable
                               double defaultValue)

Returns the value at the specified fieldPath as a double or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getFloat

public static float getFloat(@API.NonNullable
                             Document document,
                             @API.NonNullable
                             FieldPath fieldPath,
                             float defaultValue)

Returns the value at the specified fieldPath as a float or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getFloat

public static float getFloat(@API.NonNullable
                             Document document,
                             @API.NonNullable
                             String fieldPath,
                             @API.Nullable
                             float defaultValue)

Returns the value at the specified fieldPath as a float or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getInt

public static int getInt(@API.NonNullable
                         Document document,
                         @API.NonNullable
                         FieldPath fieldPath,
                         int defaultValue)

Returns the value at the specified fieldPath as a int or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getInt

public static int getInt(@API.NonNullable
                         Document document,
                         @API.NonNullable
                         String fieldPath,
                         @API.Nullable
                         int defaultValue)

Returns the value at the specified fieldPath as a int or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getInterval

public static OInterval getInterval(@API.NonNullable
                                    Document document,
                                    @API.NonNullable
                                    FieldPath fieldPath,
                                    @API.Nullable
                                    OInterval defaultValue)

Returns the value at the specified fieldPath as a OInterval or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not of the INTERVAL type

getInterval

public static OInterval getInterval(@API.NonNullable
                                    Document document,
                                    @API.NonNullable
                                    String fieldPath,
                                    @API.Nullable
                                    OInterval defaultValue)

Returns the value at the specified fieldPath as a OInterval or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not of the INTERVAL type

getList

public static List<Object> getList(@API.NonNullable
                                   Document document,
                                   @API.NonNullable
                                   FieldPath fieldPath,
                                   @API.Nullable
                                   List<Object> defaultValue)

Returns the value at the specified fieldPath as a List or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not of the ARRAY type

getList

public static List<Object> getList(@API.NonNullable
                                   Document document,
                                   @API.NonNullable
                                   String fieldPath,
                                   @API.Nullable
                                   List<Object> defaultValue)

Returns the value at the specified fieldPath as a List or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not of the ARRAY type

getLong

public static long getLong(@API.NonNullable
                           Document document,
                           @API.NonNullable
                           FieldPath fieldPath,
                           long defaultValue)

Returns the value at the specified fieldPath as a long or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getLong

public static long getLong(@API.NonNullable
                           Document document,
                           @API.NonNullable
                           String fieldPath,
                           long defaultValue)

Returns the value at the specified fieldPath as a long or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getMap

public static Map<String,Object> getMap(@API.NonNullable
                                        Document document,
                                        @API.NonNullable
                                        FieldPath fieldPath,
                                        @API.Nullable
                                        Map<String,Object> defaultValue)

Returns the value at the specified fieldPath as a Map or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not of the MAP type

getMap

public static Map<String,Object> getMap(@API.NonNullable
                                        Document document,
                                        @API.NonNullable
                                        String fieldPath,
                                        @API.Nullable
                                        Map<String,Object> defaultValue)

Returns the value at the specified fieldPath as a Map or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not of the MAP type

getShort

public static short getShort(@API.NonNullable
                             Document document,
                             @API.NonNullable
                             FieldPath fieldPath,
                             short defaultValue)

Returns the value at the specified fieldPath as a short or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getShort

public static short getShort(@API.NonNullable
                             Document document,
                             @API.NonNullable
                             String fieldPath,
                             short defaultValue)

Returns the value at the specified fieldPath as a short or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not one of the numeric types

getString

public static String getString(@API.NonNullable
                               Document document,
                               @API.NonNullable
                               FieldPath fieldPath,
                               @API.Nullable
                               String defaultValue)

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

Throws:

TypeException - if the value at the fieldPath is not of the STRING type

getString

public static String getString(@API.NonNullable
                               Document document,
                               @API.NonNullable
                               String fieldPath,
                               @API.Nullable
                               String defaultValue)

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

Throws:

TypeException - if the value at the fieldPath is not of the STRING type

getTime

public static OTime getTime(@API.NonNullable
                            Document document,
                            @API.NonNullable
                            FieldPath fieldPath,
                            @API.Nullable
                            OTime defaultValue)

Returns the value at the specified fieldPath as a OTime or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not of the TIME type

getTime

public static OTime getTime(@API.NonNullable
                            Document document,
                            @API.NonNullable
                            String fieldPath,
                            @API.Nullable
                            OTime defaultValue)

Returns the value at the specified fieldPath as a OTime or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not of the TIME type

getTimestamp

public static OTimestamp getTimestamp(@API.NonNullable
                                      Document document,
                                      @API.NonNullable
                                      FieldPath fieldPath,
                                      @API.Nullable
                                      OTimestamp defaultValue)

Returns the value at the specified fieldPath as a OTimestamp or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not of the TIMESTAMP type

getTimestamp

public static OTimestamp getTimestamp(@API.NonNullable
                                      Document document,
                                      @API.NonNullable
                                      String fieldPath,
                                      @API.Nullable
                                      OTimestamp defaultValue)

Returns the value at the specified fieldPath as a OTimestamp or the specified defaultValue if the specified FieldPath does not exist in the document.

Throws:

TypeException - if the value at the fieldPath is not of the TIMESTAMP type

getValue

public static Value getValue(@API.NonNullable
                             Document document,
                             @API.NonNullable
                             FieldPath fieldPath,
                             @API.Nullable
                             Value defaultValue)

Returns the value at the specified fieldPath as a Value or the specified defaultValue if the specified FieldPath does not exist in the document.

getValue

public static Value getValue(@API.NonNullable
                             Document document,
                             @API.NonNullable
                             String fieldPath,
                             @API.Nullable
                             Value defaultValue)

Returns the value at the specified fieldPath as a Value or the specified defaultValue if the specified FieldPath does not exist in the document.