com.bigdata.rdf.internal.impl.literal

Class LiteralExtensionIV<V extends BigdataLiteral>

java.lang.Object

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

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

com.bigdata.rdf.internal.impl.AbstractInlineExtensionIV<V,Object>

com.bigdata.rdf.internal.impl.literal.LiteralExtensionIV<V>

Type Parameters:

V -

All Implemented Interfaces:

IExtensionIV, InlineLiteralIV<V,Object>, IV<V,Object>, IVCache<V,Object>, Serializable, Comparable<IV>, org.openrdf.model.Literal, org.openrdf.model.Value

public class LiteralExtensionIV<V extends BigdataLiteral>
extends AbstractInlineExtensionIV<V,Object>
implements org.openrdf.model.Literal, InlineLiteralIV<V,Object>

Class provides support for datatype Literals for which an IExtension was registered. An LiteralExtensionIV always has the inline and extension bits set. An instance of this class bundles together an inline value of some primitive data type declared by DTE with the IV of the datatype URI for the datatype literal. LiteralExtensionIV are fully inline since the datatype URI can be materialized by the IExtension while DTE identifies the value space and the point in the value space is directly inline.

Version:

$Id$

Author:

Bryan Thompson

See Also:

Serialized Form

Field Summary

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

flags

Constructor Summary

Constructors

Constructor and Description
LiteralExtensionIV(AbstractLiteralIV<BigdataLiteral,?> delegate, IV<BigdataURI,?> datatype)

Method Summary

Methods

Modifier and Type	Method and Description
int	_compareTo(IV o) Compare two IVs having the same intrinsic datatype.
V	asValue(LexiconRelation lex) Defer to the ILexiconConfiguration which has specific knowledge of how to generate an RDF value from this general purpose extension IV.
boolean	booleanValue()
int	byteLength() Return the length of the datatype IV plus the length of the delegate IV.
byte	byteValue()
XMLGregorianCalendar	calendarValue()
IV<V,Object>	clone(boolean clearCache) Return a copy of this IV.
BigDecimal	decimalValue()
double	doubleValue()
boolean	equals(Object o) Return true iff the two IVs are the same point in the same value space.
float	floatValue()
org.openrdf.model.URI	getDatatype()
AbstractLiteralIV<BigdataLiteral,?>	getDelegate()
DTEExtension	getDTEX() IFF IV.getDTE() returns DTE.Extension then this method will report the DTEExtension value that specifies the intrinsic datatype for this IV.
IV<BigdataURI,?>	getExtensionIV() Extension IV is the datatype for this literal.
Object	getInlineValue() Return the Java Object corresponding to the inline value.
String	getLabel()
String	getLanguage()
int	hashCode() Return the hash code of the long epoch value.
BigInteger	integerValue()
int	intValue()
long	longValue()
boolean	needsMaterialization() Even though Literal extension IVs are fully inline (no data in the lexicon indices), we do need materialization to answer the openrdf Literal interface correctly.
short	shortValue()
String	stringValue()
String	toString()

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

isInline

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

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

Methods inherited from class java.lang.Object

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

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

encode, flags, getDTE, getVTE, isBigNumeric, isBNode, isExtension, isFixedNumeric, isFloatingPointNumeric, isInline, isLiteral, isNullIV, isNumeric, isResource, isSignedNumeric, isStatement, isUnsignedNumeric, isURI, isVocabulary

Methods inherited from interface java.lang.Comparable

compareTo

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

getValue, hasValue, setValue

Constructor Detail

LiteralExtensionIV

public LiteralExtensionIV(AbstractLiteralIV<BigdataLiteral,?> delegate,
                  IV<BigdataURI,?> datatype)

Method Detail

clone

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

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.

Note: The extensionIV and delegateIV are NOT cloned. The rationale is that we are only cloning to break the hard reference from the IV to to cached value. If that needs to be done for the extensionIV and delegateIV, then it will be done separately for those objects when they are inserted into the termsCache.

Specified by:

clone in interface IVCache<V extends BigdataLiteral,Object>

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)

needsMaterialization

public boolean needsMaterialization()

Even though Literal extension IVs are fully inline (no data in the lexicon indices), we do need materialization to answer the openrdf Literal interface correctly. We cannot properly interpret what the delegate IV means without the materialized value.

Specified by:

needsMaterialization in interface IV<V extends BigdataLiteral,Object>

getDelegate

public AbstractLiteralIV<BigdataLiteral,?> getDelegate()

getInlineValue

public Object getInlineValue()

Description copied from interface: IV

Return the Java Object corresponding to the inline value.

Specified by:

getInlineValue in interface IV<V extends BigdataLiteral,Object>

Returns:

The Object.

getDTEX

public DTEExtension getDTEX()

Description copied from interface: IV

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

Specified by:

getDTEX in interface IV<V extends BigdataLiteral,Object>

Overrides:

getDTEX in class AbstractIV<V extends BigdataLiteral,Object>

See Also:

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

getExtensionIV

public IV<BigdataURI,?> getExtensionIV()

Extension IV is the datatype for this literal.

Specified by:

getExtensionIV in interface IExtensionIV

hashCode

public int hashCode()

Return the hash code of the long epoch value.

Specified by:

hashCode in interface org.openrdf.model.Literal

Specified by:

hashCode in class AbstractIV<V extends BigdataLiteral,Object>

equals

public boolean equals(Object o)

Description copied from class: AbstractIV

Return true iff the two IVs are the same point in the same value space. Points in different value spaces (as identified by different datatype URIs) are NOT equal even if they have the same value in the corresponding primitive data type.

Note: The IV implementations typically DO NOT compare equals() with BigdataValues. Therefore you MUST NOT mix IVs and BigdataValues in the keys of a map or the values of a set.

Specified by:

equals in interface org.openrdf.model.Literal

Specified by:

equals in class AbstractIV<V extends BigdataLiteral,Object>

_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 BigdataLiteral,Object>

byteLength

public int byteLength()

Return the length of the datatype IV plus the length of the delegate IV.

Specified by:

byteLength in interface IV<V extends BigdataLiteral,Object>

asValue

public V asValue(LexiconRelation lex)

Defer to the ILexiconConfiguration which has specific knowledge of how to generate an RDF value from this general purpose extension IV.

If the value is not already cached, then inflate an inline RDF value to a BigdataValue and cache it on a private field.

Note: Query plans are responsible for ensuring that IVs have been materialized before operators are evaluated which invoke this method. This pattern ensures that efficient batch operators are used to materialize Values, and thereby avoids heavy RMI overhead in scale-out, and provides operators which use IVCache.getValue() with a simple method signature which does not require access to the lexicon. Query plans are also responsible for dropping variables once they are no longer needed or, in the case of large values and BLOBs, dropping the cached BigdataValue when possible in order to avoid excess network and heap overhead.

Specified by:

asValue in interface IVCache<V extends BigdataLiteral,Object>

Parameters:

lex - The lexicon relation (this is required in order to access the BigdataValueFactory for the namespace associated with lexicon when we materialize an inline IV).

Returns:

The corresponding BigdataValue.

stringValue

public String stringValue()

Specified by:

stringValue in interface org.openrdf.model.Value

booleanValue

public boolean booleanValue()

Specified by:

booleanValue in interface org.openrdf.model.Literal

byteValue

public byte byteValue()

Specified by:

byteValue in interface org.openrdf.model.Literal

calendarValue

public XMLGregorianCalendar calendarValue()

Specified by:

calendarValue in interface org.openrdf.model.Literal

decimalValue

public BigDecimal decimalValue()

Specified by:

decimalValue in interface org.openrdf.model.Literal

doubleValue

public double doubleValue()

Specified by:

doubleValue in interface org.openrdf.model.Literal

floatValue

public float floatValue()

Specified by:

floatValue in interface org.openrdf.model.Literal

getDatatype

public org.openrdf.model.URI getDatatype()

Specified by:

getDatatype in interface org.openrdf.model.Literal

getLabel

public String getLabel()

Specified by:

getLabel in interface org.openrdf.model.Literal

getLanguage

public String getLanguage()

Specified by:

getLanguage in interface org.openrdf.model.Literal

intValue

public int intValue()

Specified by:

intValue in interface org.openrdf.model.Literal

integerValue

public BigInteger integerValue()

Specified by:

integerValue in interface org.openrdf.model.Literal

longValue

public long longValue()

Specified by:

longValue in interface org.openrdf.model.Literal

shortValue

public short shortValue()

Specified by:

shortValue in interface org.openrdf.model.Literal

toString

public String toString()

Overrides:

toString in class Object