com.bigdata.rdf.internal.impl

Class TermId<V extends BigdataValue>

java.lang.Object

com.bigdata.rdf.internal.impl.AbstractIV<V,T>

com.bigdata.rdf.internal.impl.AbstractNonInlineIV<V,Void>

com.bigdata.rdf.internal.impl.TermId<V>

All Implemented Interfaces:

IV<V,Void>, IVCache<V,Void>, Serializable, Comparable<IV>, org.openrdf.model.BNode, org.openrdf.model.Literal, org.openrdf.model.Resource, org.openrdf.model.URI, org.openrdf.model.Value

public class TermId<V extends BigdataValue>
extends AbstractNonInlineIV<V,Void>

Implementation for any kind of RDF Value when the values is not being inlined. Instances of this class can represent URIs, BNodes (if they are not being inlined), or Literals (including datatype literals if they are not being inlined). Larger RDF Values should be represented with BlobIV instead of this class.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	NULL Value used for a "NULL" term identifier.
static TermId<?>	NullIV Singleton for a "null" IV.

Fields inherited from class com.bigdata.rdf.internal.impl.AbstractIV

flags

Constructor Summary

Constructors

Constructor and Description
TermId(byte flags, long termId) Constructor for a term identifier when you are decoding and already have the flags.
TermId(VTE vte, long termId) Constructor for a term identifier.

Method Summary

Methods

Modifier and Type	Method and Description
int	_compareTo(IV o) Compare two IVs having the same intrinsic datatype.
int	byteLength() The byte length of the encoded IV.
IV<V,Void>	clone(boolean clearCache) Return a copy of this IV.
IKeyBuilder	encode(IKeyBuilder keyBuilder) Encode the IV as an unsigned byte[].
boolean	equals(Object o) Note: only the termId matters for equality, unless either is #NULL, in which case this will compare the cached {@link BigdataValue}s if they exist.
static TermId<?>	fromString(String s) Decodes the output of toString(), returning a new TermId .
String	getID() Overrides BNode.getID().
long	getTermId() Return the termId.
int	hashCode() Return the hash code of the long term identifier.
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).
static TermId<?>	mockIV(VTE vte) Create a mock IV having the indicated VTE which will report true for isNullIV().
String	toString() Human readable representation includes the term identifier, whether this is a URI, Literal, Blank node, or Statement identifier and the datatype URI if one is assigned.

Methods inherited from class com.bigdata.rdf.internal.impl.AbstractNonInlineIV

asValue, booleanValue, byteValue, calendarValue, decimalValue, doubleValue, floatValue, getDatatype, getInlineValue, getLabel, getLanguage, getLocalName, getNamespace, integerValue, intValue, isInline, longValue, needsMaterialization, shortValue, stringValue

Methods inherited from class com.bigdata.rdf.internal.impl.AbstractIV

compareTo, flags, getDTE, getDTE, getDTEX, getInternalValueTypeEnum, getValue, getValueCache, getVTE, getVTE, hasValue, isBigNumeric, isBNode, isExtension, isExtension, isFixedNumeric, isFloatingPointNumeric, isInline, isLiteral, isResource, isSignedNumeric, isStatement, isUnsignedNumeric, isURI, isVocabulary, setValue, toFlags

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NULL

public static final transient long NULL

Value used for a "NULL" term identifier.

See Also:

Constant Field Values

NullIV

public static final transient TermId<?> NullIV

Singleton for a "null" IV.

Constructor Detail

TermId

public TermId(byte flags,
      long termId)

Constructor for a term identifier when you are decoding and already have the flags.

Parameters:

flags - The flags

termId -

TermId

public TermId(VTE vte,
      long termId)

Constructor for a term identifier.

Parameters:

vte -

termId -

Method Detail

isNullIV

public final boolean isNullIV()

Description copied from class: AbstractIV

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.

This implementation returns false. It is overridden by TermId.

Specified by:

isNullIV in interface IV<V extends BigdataValue,Void>

Overrides:

isNullIV in class AbstractIV<V extends BigdataValue,Void>

mockIV

public static TermId<?> mockIV(VTE vte)

Create a mock IV having the indicated VTE which will report true for isNullIV(). This is used by some code patterns where we need to associate a BigdataValue not in the database with an IV on a temporary basis.

Parameters:

vte - The VTE.

Returns:

The mock IV.

clone

public IV<V,Void> clone(boolean clearCache)

Description copied from interface: IVCache

Return a copy of this IV.

Note: This method exists to defeat the hard reference from the IV to the cached BigdataValue in order to avoid a memory leak when the IV is used as the key in a weak value cache whose value is the BigdataValue. Therefore, certain IV implementations MAY return this when they are used for limited collections. The vocabulary IVs are the primary example. For the same reason, we do not need to recursively break the link from the IV to the BigdataValue for IVs which embed other IVs.

Parameters:

clearCache - When true the cached reference (if any) will NOT be set on the copy.

Returns:

The copy.

See Also:

(Thread-local cache combined with unbounded thread pools causes effective memory leak)

toString

public String toString()

Human readable representation includes the term identifier, whether this is a URI, Literal, Blank node, or Statement identifier and the datatype URI if one is assigned. This representation is based solely on the flag bits and the term identifier.

The cached BigdataValue, if any, is also rendered. This is done using Value.stringValue() in order to avoid possible infinite recursion through BigdataValue#toString() if the latter were to display the IV.

Specified by:

toString in interface org.openrdf.model.URI

Overrides:

toString in class Object

fromString

public static TermId<?> fromString(String s)

Decodes the output of toString(), returning a new TermId .

Parameters:

s - The string representation.

Returns:

The TermIV.

getTermId

public final long getTermId()

Return the termId.

equals

public boolean equals(Object o)

Note: only the termId matters for equality, unless either is #NULL, in which case this will compare the cached {@link BigdataValue}s if they exist. Null IVs without cached values are never equal.

Specified by:

equals in interface org.openrdf.model.BNode

Specified by:

equals in interface org.openrdf.model.Literal

Specified by:

equals in interface org.openrdf.model.URI

Specified by:

equals in class AbstractIV<V extends BigdataValue,Void>

hashCode

public int hashCode()

Return the hash code of the long term identifier.

Specified by:

hashCode in interface org.openrdf.model.BNode

Specified by:

hashCode in interface org.openrdf.model.Literal

Specified by:

hashCode in interface org.openrdf.model.URI

Specified by:

hashCode in class AbstractIV<V extends BigdataValue,Void>

See Also:

Long.hashCode()

byteLength

public int byteLength()

Description copied from interface: IV

The byte length of the encoded IV.

_compareTo

public int _compareTo(IV o)

Description copied from class: AbstractIV

Compare two IVs having the same intrinsic datatype.

Specified by:

_compareTo in class AbstractIV<V extends BigdataValue,Void>

encode

public IKeyBuilder encode(IKeyBuilder keyBuilder)

Description copied from interface: IV

Encode the IV as an unsigned byte[].

Specified by:

encode in interface IV<V extends BigdataValue,Void>

Overrides:

encode in class AbstractIV<V extends BigdataValue,Void>

Parameters:

keyBuilder - The object used to encode the IV.

Returns:

the key builder

getID

public String getID()

Overrides BNode.getID().

Creates a unique blank node ID based on the TermId's internal data.

Specified by:

getID in interface org.openrdf.model.BNode

Overrides:

getID in class AbstractNonInlineIV<V extends BigdataValue,Void>

isNumeric

public boolean isNumeric()

Description copied from interface: IV

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).

Specified by:

isNumeric in interface IV<V extends BigdataValue,Void>

Overrides:

isNumeric in class AbstractIV<V extends BigdataValue,Void>