com.bigdata.rdf.internal

Interface IV<V extends BigdataValue,T>

Type Parameters:

V - The generic type for the RDF Value implementation.

T - The generic type for the inline value.

All Superinterfaces:

Comparable<IV>, IVCache<V,T>, Serializable, org.openrdf.model.Value

All Known Subinterfaces:

InlineLiteralIV<V,T>

All Known Implementing Classes:

AbstractBNodeIV, AbstractInlineExtensionIV, AbstractInlineIV, AbstractIV, AbstractLiteralIV, AbstractNonInlineExtensionIV, AbstractNonInlineExtensionIVWithDelegateIV, AbstractNonInlineIV, BlobIV, FullyInlineTypedLiteralIV, FullyInlineUnicodeBNodeIV, FullyInlineURIIV, IPv4AddrIV, LiteralArrayIV, LiteralExtensionIV, MockedValueIV, NumericBNodeIV, NumericIV, PackedLongIV, PartlyInlineTypedLiteralIV, PartlyInlineURIIV, SidIV, TermId, URIExtensionIV, UUIDBNodeIV, UUIDLiteralIV, VocabURIByteIV, VocabURIShortIV, XSDBooleanIV, XSDDecimalIV, XSDIntegerIV, XSDNumericIV, XSDUnsignedByteIV, XSDUnsignedIntIV, XSDUnsignedLongIV, XSDUnsignedShortIV

public interface IV<V extends BigdataValue,T>
extends Serializable, Comparable<IV>, IVCache<V,T>, org.openrdf.model.Value

Interface for the internal representation of an RDF Value (the representation which is encoded within the statement indices).

Method Summary

Methods

Modifier and Type	Method and Description
int	byteLength() The byte length of the encoded IV.
IKeyBuilder	encode(IKeyBuilder keyBuilder) Encode the IV as an unsigned byte[].
byte	flags() The value of the flags representing the VTE and the DTE.
DTE	getDTE() Return the DTE for the IV .
DTEExtension	getDTEX() IFF getDTE() returns DTE.Extension then this method will report the DTEExtension value that specifies the intrinsic datatype for this IV.
T	getInlineValue() Return the Java Object corresponding to the inline value.
VTE	getVTE() Return the VTE for the IV
boolean	isBigNumeric() true for xsd:integer and xsd:decimal.
boolean	isBNode() Return true iff this is an RDF BlankNode.
boolean	isExtension() true iff the flags byte is followed by an IV which defines how the subsequent value (represented according to the DTE) will be interpreted.
boolean	isFixedNumeric() This is !isBigNumeric() and is true for any of the fixed length numeric data types (xsd:byte, xsd:unsignedByte, xsd:short, xsd:unsignedShort, xsd:int, xsd:unsignedInt, xsd:long, xsd:unsignedLong, xsd:float, xsd:double).
boolean	isFloatingPointNumeric() true for xsd:float, xsd:double, and xsd:decimal
boolean	isInline() true iff the RDF value is directly represented inline.
boolean	isLiteral() Return true iff this is an RDF Literal.
boolean	isNullIV() true iff the IV represents a null IV reference.
boolean	isNumeric() true for any of the numeric data types (xsd:byte, xsd:unsignedByte, xsd:short, xsd:unsignedShort, xsd:int, xsd:unsignedInt, xsd:long, xsd:unsignedLong, xsd:float, xsd:double, xsd:integer, and xsd:decimal).
boolean	isResource() Return true iff this is a URI or a bnode.
boolean	isSignedNumeric() true for an signed numeric datatype ( xsd:byte, xsd:short, xsd:int, xsd:long, xsd:float, xsd:double, xsd:integer, and xsd:decimal).
boolean	isStatement() Return true iff this is a statement identifier (this feature is enabled with AbstractTripleStore.Options.STATEMENT_IDENTIFIERS).
boolean	isUnsignedNumeric() true for an unsigned numeric datatype ( xsd:unsignedByte, xsd:unsignedShort, xsd:unsignedInt, xsd:unsignedLong).
boolean	isURI() Return true iff this is an RDF URI.
boolean	isVocabulary() Return true iff this IV is a Vocabulary item.
boolean	needsMaterialization() Each concrete IV implementation will implement one of the corresponding openrdf Value interfaces depending on the type of value the IV represents (URI, BNode, or Literal).

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.bigdata.rdf.internal.IVCache

asValue, clone, getValue, hasValue, setValue

Methods inherited from interface org.openrdf.model.Value

stringValue

Method Detail

flags

byte flags()

The value of the flags representing the VTE and the DTE. The upper TWO (2) bits code the VTE while the lower SIX (6) bits code the DTE.

byteLength

int byteLength()

The byte length of the encoded IV.

encode

IKeyBuilder encode(IKeyBuilder keyBuilder)

Encode the IV as an unsigned byte[].

Parameters:

keyBuilder - The object used to encode the IV.

Returns:

the key builder

getVTE

VTE getVTE()

Return the VTE for the IV

isLiteral

boolean isLiteral()

Return true iff this is an RDF Literal. Note that some kinds of RDF Literals MAY be represented inline.

isBNode

boolean isBNode()

Return true iff this is an RDF BlankNode.

isURI

boolean isURI()

Return true iff this is an RDF URI.

isStatement

boolean isStatement()

Return true iff this is a statement identifier (this feature is enabled with AbstractTripleStore.Options.STATEMENT_IDENTIFIERS).

isResource

boolean isResource()

Return true iff this is a URI or a bnode.

getDTE

DTE getDTE()

Return the DTE for the IV . This will be DTE#TermId iff the internal "value" is a term identifier. Otherwise it will be the type safe enum corresponding to the specific data type which can be decoded from this IV using getInlineValue().

getDTEX

DTEExtension getDTEX()

IFF getDTE() returns DTE.Extension then this method will report the DTEExtension value that specifies the intrinsic datatype for this IV.

See Also:

(Implement support for DTE extension types for URIs), ( DTEExtension for compressed timestamp)

isNullIV

boolean isNullIV()

true iff the IV represents a null IV reference. null IVs are somewhat special. They get used as wild cards for the keys in the justifications index and perhaps (?) in a few other locations.

isInline

boolean isInline()

true iff the RDF value is directly represented inline. When an RDF Value is "inline" its value can be directly decoded from its representation in the keys of the statement indices.

isExtension

boolean isExtension()

true iff the flags byte is followed by an IV which defines how the subsequent value (represented according to the DTE) will be interpreted. This is used to support projections of value spaces for data type literals onto the intrinsic types. It is also used to support indirect resolution of the namespace associated with a URI.

isVocabulary

boolean isVocabulary()

Return true iff this IV is a Vocabulary item.

getInlineValue

T getInlineValue()
                 throws UnsupportedOperationException

Return the Java Object corresponding to the inline value.

Returns:

The Object.

Throws:

UnsupportedOperationException - unless the RDF value is inline.

isNumeric

boolean isNumeric()

true for any of the numeric data types (xsd:byte, xsd:unsignedByte, xsd:short, xsd:unsignedShort, xsd:int, xsd:unsignedInt, xsd:long, xsd:unsignedLong, xsd:float, xsd:double, xsd:integer, and xsd:decimal).

isSignedNumeric

boolean isSignedNumeric()

true for an signed numeric datatype ( xsd:byte, xsd:short, xsd:int, xsd:long, xsd:float, xsd:double, xsd:integer, and xsd:decimal).

isUnsignedNumeric

boolean isUnsignedNumeric()

true for an unsigned numeric datatype ( xsd:unsignedByte, xsd:unsignedShort, xsd:unsignedInt, xsd:unsignedLong).

isFixedNumeric

boolean isFixedNumeric()

This is !isBigNumeric() and is true for any of the fixed length numeric data types (xsd:byte, xsd:unsignedByte, xsd:short, xsd:unsignedShort, xsd:int, xsd:unsignedInt, xsd:long, xsd:unsignedLong, xsd:float, xsd:double).

isBigNumeric

boolean isBigNumeric()

true for xsd:integer and xsd:decimal.

isFloatingPointNumeric

boolean isFloatingPointNumeric()

true for xsd:float, xsd:double, and xsd:decimal

needsMaterialization

boolean needsMaterialization()

Each concrete IV implementation will implement one of the corresponding openrdf Value interfaces depending on the type of value the IV represents (URI, BNode, or Literal). This method signifies whether or not the IV can deliver the information needed by those interfaces with or without materialization. For example, inline numerics can implement the entire Literal interface without needing to be materialized into a BigdataLiteral. TermIds cannot answer any of the requests in the openrdf interfaces without materialization (all the relevant information is in the lexicon indices). Even some inlines need materialization. For example, ...