kv-4.0.9.src.oracle.kv.table.FieldValue Maven / Gradle / Ivy
Show all versions of oracle-nosql-client Show documentation
/*-
*
* This file is part of Oracle NoSQL Database
* Copyright (C) 2011, 2016 Oracle and/or its affiliates. All rights reserved.
*
* If you have received this file as part of Oracle NoSQL Database the
* following applies to the work as a whole:
*
* Oracle NoSQL Database server software is free software: you can
* redistribute it and/or modify it under the terms of the GNU Affero
* General Public License as published by the Free Software Foundation,
* version 3.
*
* Oracle NoSQL Database is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Affero General Public License for more details.
*
* If you have received this file as part of Oracle NoSQL Database Client or
* distributed separately the following applies:
*
* Oracle NoSQL Database client software is free software: you can
* redistribute it and/or modify it under the terms of the Apache License
* as published by the Apache Software Foundation, version 2.0.
*
* You should have received a copy of the GNU Affero General Public License
* and/or the Apache License in the LICENSE file along with Oracle NoSQL
* Database client or server distribution. If not, see
* .
*
* An active Oracle commercial licensing agreement for this product supersedes
* these licenses and in such case the license notices, but not the copyright
* notice, may be removed by you in connection with your distribution that is
* in accordance with the commercial licensing terms.
*
* For more information please contact:
*
* [email protected]
*
*/
package oracle.kv.table;
/**
* FieldValue represents an item, that is, a value and its associated type.
* Values can be atomic or complex. An atomic value is a single, indivisible
* unit of data. A complex value is a value that contains or consists of other
* values and provides access to its nested values.
*
* FieldValue is the building block of row values in a table.
*
* The FieldValue interface defines casting and interrogation methods common to
* all implementing classes. Each implementing type has its own interface
* which is an extension of FieldValue. In most cases interfaces that extend
* FieldValue have corresponding classes that extend {@link FieldDef}. The
* exceptions are {@link Row}, {@link PrimaryKey} and {@link IndexKey}. These
* all extend {@link RecordValue} as they are specialized instances of records.
*
* By default fields can be nullable, which means that a special null value can
* be assigned to them. A null value is a FieldValue instance that returns true
* for {@link #isNull} and will throw exceptions for most other operations that
* require an actual instance of a type. This means that callers who might
* reasonably expect a null value should first check to see if the value is null
* before using the value.
*
* FieldValue instances are not thread safe.
*
* @since 3.0
*/
public interface FieldValue extends Comparable {
/**
* Create a deep copy of this object.
*
* @return a new copy
*/
FieldValue clone();
/**
* Returns the kind of the type associated with this value. The method will
* never return any of the "wildcard" types (ANY, ANY_ATOMIC, ANY_RECORD).
*
* @return the type of this value
*
* @throws UnsupportedOperationException if this is the NullValue
*/
FieldDef.Type getType();
/**
* Returns the type associated with this value.
*
* @return the FieldDef
*
* @throws UnsupportedOperationException if this is the NullValue
*/
FieldDef getDefinition();
/**
* Returns true if this is a {@link BooleanValue}.
*
* @return true if this is a BooleanValue, false otherwise
*/
boolean isBoolean();
/**
* Returns true if this is a {@link BinaryValue}.
*
* @return true if this is a BinaryValue, false otherwise
*/
boolean isBinary();
/**
* Returns true if this is a {@link DoubleValue}.
*
* @return true if this is a DoubleValue, false otherwise
*/
boolean isDouble();
/**
* Returns true if this is an {@link EnumValue}.
*
* @return true if this is an EnumValue, false otherwise
*/
boolean isEnum();
/**
* Returns true if this is a {@link FixedBinaryValue}.
*
* @return true if this is a FixedBinaryValue, false otherwise
*/
boolean isFixedBinary();
/**
* Returns true if this is a {@link FloatValue}.
*
* @return true if this is a FloatValue, false otherwise
*/
boolean isFloat();
/**
* Returns true if this is an {@link IntegerValue}.
*
* @return true if this is an IntegerValue, false otherwise
*/
boolean isInteger();
/**
* Returns true if this is a {@link LongValue}.
*
* @return true if this is a LongValue, false otherwise
*/
boolean isLong();
/**
* Returns true if this is a {@link StringValue}.
*
* @return true if this is a StringValue, false otherwise
*/
boolean isString();
/**
* Returns true if this is an {@link ArrayValue}.
*
* @return true if this is an ArrayValue, false otherwise
*/
boolean isArray();
/**
* Returns true if this is a {@link MapValue}.
*
* @return true if this is a MapValue, false otherwise
*/
boolean isMap();
/**
* Returns true if this is a {@link RecordValue}.
*
* @return true if this is a RecordValue, false otherwise
*/
boolean isRecord();
/**
* Returns true if this is a {@link Row}. Row also
* returns true for {@link #isRecord}.
*
* @return true if this is a Row}, false otherwise
*/
boolean isRow();
/**
* Returns true if this is a {@link PrimaryKey}. PrimaryKey also
* returns true for {@link #isRecord} and {@link #isRow}.
*
* @return true if this is a PrimaryKey}, false otherwise
*/
boolean isPrimaryKey();
/**
* Returns true if this is an {@link IndexKey}. IndexKey also
* returns true for {@link #isRecord}.
*
* @return true if this is an IndexKey}, false otherwise
*/
boolean isIndexKey();
/**
* Returns true if this is a null value instance.
*
* @return true if this is a null value, false otherwise.
*/
boolean isNull();
/**
* Returns true if this is an atomic value.
*
* @return true if this is a scalar value, false otherwise
*
* @since 4.0
*/
boolean isAtomic();
/**
* Returns true if this is numeric value.
*
* @return true if this is a numeric value, false otherwise
*
* @since 4.0
*/
boolean isNumeric();
/**
* Returns true if this is a complex value.
*
* @return true if this is a complex value, false otherwise
*
* @since 4.0
*/
boolean isComplex();
/**
* Casts to BinaryValue.
*
* @return a BinaryValue
*
* @throws ClassCastException if this is not a BinaryValue
*/
BinaryValue asBinary();
/**
* Casts to BooleanValue.
*
* @return a BooleanValue
*
* @throws ClassCastException if this is not a BooleanValue
*/
BooleanValue asBoolean();
/**
* Casts to DoubleValue.
*
* @return a DoubleValue
*
* @throws ClassCastException if this is not a DoubleValue
*/
DoubleValue asDouble();
/**
* Casts to EnumValue.
*
* @return an EnumValue
*
* @throws ClassCastException if this is not an EnumValue
*/
EnumValue asEnum();
/**
* Casts to FixedBinaryValue.
*
* @return a FixedBinaryValue
*
* @throws ClassCastException if this is not a FixedBinaryValue
*/
FixedBinaryValue asFixedBinary();
/**
* Casts to FloatValue.
*
* @return a FloatValue
*
* @throws ClassCastException if this is not a FloatValue
*/
FloatValue asFloat();
/**
* Casts to IntegerValue.
*
* @return an IntegerValue
*
* @throws ClassCastException if this is not an IntegerValue
*/
IntegerValue asInteger();
/**
* Casts to LongValue.
*
* @return a LongValue
*
* @throws ClassCastException if this is not a LongValue
*/
LongValue asLong();
/**
* Casts to StringValue.
*
* @return a StringValue
*
* @throws ClassCastException if this is not a StringValue
*/
StringValue asString();
/**
* Casts to ArrayValue.
*
* @return an ArrayValue
*
* @throws ClassCastException if this is not an ArrayValue
*/
ArrayValue asArray();
/**
* Casts to MapValue.
*
* @return a MapValue
*
* @throws ClassCastException if this is not a MapValue
*/
MapValue asMap();
/**
* Casts to RecordValue.
*
* @return a RecordValue
*
* @throws ClassCastException if this is not a RecordValue
*/
RecordValue asRecord();
/**
* Casts to Row.
*
* @return a Row
*
* @throws ClassCastException if this is not a Row.
*/
Row asRow();
/**
* Casts to PrimaryKey.
*
* @return a PrimaryKey
*
* @throws ClassCastException if this is not a PrimaryKey
*/
PrimaryKey asPrimaryKey();
/**
* Casts to IndexKey.
*
* @return an IndexKey
*
* @throws ClassCastException if this is not an IndexKey
*/
IndexKey asIndexKey();
/**
* Create a JSON representation of the value.
*
* @param prettyPrint set to true for a nicely formatted JSON string,
* with indentation and carriage returns, otherwise the string will be a
* single line
*
* @return a JSON representation of the value
*/
String toJsonString(boolean prettyPrint);
}