com.bigdata.rdf.model

Class BigdataValueSerializer<V extends org.openrdf.model.Value>

java.lang.Object

com.bigdata.rdf.model.BigdataValueSerializer<V>

public class BigdataValueSerializer<V extends org.openrdf.model.Value>
extends Object

Helper class provides efficient stand-off serialization of RDF Value objects.

Version:

$Id$

Author:

Bryan Thompson

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ERR_CODE Error message indicates that the term code in the serialized record did not correspond to a known term code for an RDF value of the appropriate type (e.g., a URI code where an Literal code was expected).
protected static String	ERR_VERSION Error message indicates that the version code in the serialized record did not correspond to a known serialization version for an RDF value.

Constructor Summary

Constructors

Constructor and Description
BigdataValueSerializer(org.openrdf.model.ValueFactory valueFactory) Create an instance that will materialize objects using the caller's factory.

Method Summary

Methods

Modifier and Type	Method and Description
V	deserialize(byte[] b) Routine for efficient de-serialization of an RDF Value.
V	deserialize(DataInputBuffer in, StringBuilder tmp) Routine for efficient de-serialization of a BigdataValue.
static long	getStringLength(org.openrdf.model.Value v) Return the total #of characters in the RDF Value.
byte[]	serialize(V val) Routine for efficient serialization of an RDF Value.
byte[]	serialize(V val, DataOutputBuffer out, ByteArrayBuffer tmp) Variant which permits reuse of the same buffer.
void	serialize2(V val, DataOutputBuffer out, ByteArrayBuffer tmp) Variant which permits reuse of the same buffer and avoids copying the data once it has been formated onto the caller's DataOutputBuffer (core impl).

Methods inherited from class java.lang.Object

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

Field Detail

ERR_VERSION

protected static final String ERR_VERSION

Error message indicates that the version code in the serialized record did not correspond to a known serialization version for an RDF value.

See Also:

Constant Field Values

ERR_CODE

protected static final String ERR_CODE

Error message indicates that the term code in the serialized record did not correspond to a known term code for an RDF value of the appropriate type (e.g., a URI code where an Literal code was expected). The codes are defined by ITermIndexCodes.

See Also:

Constant Field Values

Constructor Detail

BigdataValueSerializer

public BigdataValueSerializer(org.openrdf.model.ValueFactory valueFactory)

Create an instance that will materialize objects using the caller's factory.

Parameters:

valueFactory - The value factory.

Method Detail

serialize

public byte[] serialize(V val)

Routine for efficient serialization of an RDF Value.

Returns:

The byte[] containing the serialized data record.

Throws:

RuntimeException - if there is a IO problem

See Also:

#deserialize(byte[])}

serialize

public byte[] serialize(V val,
               DataOutputBuffer out,
               ByteArrayBuffer tmp)

Variant which permits reuse of the same buffer. This has the advantage that the buffer is reused on each invocation and swiftly grows to its maximum extent.

Parameters:

val - The value.

out - The buffer - the caller is responsible for resetting the buffer before each invocation.

tmp - A buffer used to compress the component Unicode strings. This will be reset as necessary by this method. It will be lazily allocated if null.

Returns:

The byte[] containing the serialized data record. This array is newly allocated so that a series of invocations of this method return distinct byte[]s.

serialize2

public void serialize2(V val,
              DataOutputBuffer out,
              ByteArrayBuffer tmp)

Variant which permits reuse of the same buffer and avoids copying the data once it has been formated onto the caller's DataOutputBuffer (core impl).

Parameters:

val - The value.

out - The buffer - the caller is responsible for resetting the buffer before each invocation.

tmp - A buffer used to compress the component Unicode strings. This will be reset as necessary by this method. It will be lazily allocated if null.

deserialize

public V deserialize(byte[] b)

Routine for efficient de-serialization of an RDF Value.

Note: This automatically uses the BigdataValueFactoryImpl to create the BigdataValues from the de-serialized state so the factory reference is always set on the returned BigdataValueImpl.

Parameters:

b - The byte[] containing the serialized data record.

Returns:

The BigdataValue.

Throws:

RuntimeException - if there is an IO problem.

See Also:

#serialize()}

deserialize

public V deserialize(DataInputBuffer in,
            StringBuilder tmp)

Routine for efficient de-serialization of a BigdataValue.

Note: This automatically uses the BigdataValueFactoryImpl to create the BigdataValues from the de-serialized state so the factory reference is always set on the returned BigdataValueImpl.

Parameters:

b - An input stream from which the serialized data may be read.

tmp - A buffer used to decode the component Unicode strings. The length of the buffer will be reset as necessary by this method.

Returns:

The BigdataValue.

Throws:

RuntimeException - if there is an IO problem.

See Also:

#serialize()}

getStringLength

public static long getStringLength(org.openrdf.model.Value v)

Return the total #of characters in the RDF Value.

Parameters:

v - The Value.

Returns:

The character length of the data in the RDF Value.