org.hypergraphdb.type.javaprimitive

Class StringType

java.lang.Object

org.hypergraphdb.type.javaprimitive.PrimitiveTypeBase<String>

org.hypergraphdb.type.javaprimitive.StringType

All Implemented Interfaces:

HGGraphHolder, HGOrderedSearchable<String,HGPersistentHandle>, HGSearchable<String,HGPersistentHandle>, ByteArrayConverter<String>, HGAtomType, HGPrimitiveType<String>, HGRefCountedType

public class StringType
extends PrimitiveTypeBase<String>

The implementation of the primitive String type.

This implementation should be used only for relatively small strings, things like names or titles, since they are indexed and reference counted for lookup. If you want to store larger text data, including big documents, use the TextType instead.

A java.lang.String object is translated to a byte [] as follows:

• The first 4 bytes consitute an unsigned integer - the reference count for the string. The reference count is managed by the superclass
• The fifth byte is a descriptor tag that indicates whether the string is null, empty or it has actual content: 0 means null, 1 means empty and 2 means we have something. In the future this might be extended to support various encodings.
• The rest of the bytes constitute the actual string with the default 8-bit Java encoding.

Author:

Borislav Iordanov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StringType.CaseInsensitiveStringComparator
static class	StringType.StringComparator

Field Summary

Fields

Modifier and Type	Field and Description
static String	INDEX_NAME

Fields inherited from class org.hypergraphdb.type.javaprimitive.PrimitiveTypeBase

dataOffset, graph, valueIndex

Constructor Summary

Constructors

Constructor and Description
StringType()

Method Summary

Methods

Modifier and Type	Method and Description
Comparator<byte[]>	getComparator() Return a java.util.Comparator instance that provides an order relation of the values of the primitive type.
protected String	getIndexName() Return the name of the DB index to create for the primitive values.
boolean	isCaseSensitive()
protected String	readBytes(byte[] data, int offset)
void	setCaseSensitive(boolean caseSensitive)
protected byte[]	writeBytes(String value)

Methods inherited from class org.hypergraphdb.type.javaprimitive.PrimitiveTypeBase

compare, find, findGT, findGTE, findLT, findLTE, fromByteArray, getIndex, getRefCount, getRefCountFor, make, putRefCount, release, setHyperGraph, store, storeImpl, subsumes, toByteArray

Methods inherited from class java.lang.Object

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

Field Detail

INDEX_NAME

public static final String INDEX_NAME

See Also:

Constant Field Values

Constructor Detail

StringType

public StringType()

Method Detail

getComparator

public Comparator<byte[]> getComparator()

Description copied from interface: HGPrimitiveType

Return a java.util.Comparator instance that provides an order relation of the values of the primitive type. An implementation is allowed to return null in which case it is assumed that the type does not offer an ordering relation. However, if a non-null value is returned, it is must be of a publicly available and default constructible class.

getIndexName

protected String getIndexName()

Description copied from class: PrimitiveTypeBase

Return the name of the DB index to create for the primitive values.

Specified by:

getIndexName in class PrimitiveTypeBase<String>

writeBytes

protected byte[] writeBytes(String value)

Specified by:

writeBytes in class PrimitiveTypeBase<String>

readBytes

protected String readBytes(byte[] data,
               int offset)

Specified by:

readBytes in class PrimitiveTypeBase<String>

isCaseSensitive

public boolean isCaseSensitive()

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)