Module org.apache.jena.tdb

Package org.apache.jena.tdb1.setup

Class StoreParams

java.lang.Object

org.apache.jena.tdb1.setup.StoreParams

All Implemented Interfaces:

BlockParams, IndexParams, StoreParamsDynamic

public class StoreParams
extends Object
implements IndexParams, StoreParamsDynamic

System parameters for a TDB database instance.

Some parameters can be changed from run to run and some parameters can only be changed at the point the database is created.

Getting parameters settings wrong can destroy a database. Alternating the block size is not encouraged and should only be done if necessary. It can silently destroy a database if set to a different value than that used to create the database. The default value of 8 kilobytes is good for almost use.

See Also:

• for constructing StoreParams
• for default values.

Method Summary

Modifier and Type	Method	Description
static StoreParamsBuilder	builder()	Build StoreParams, starting from system defaults.
static StoreParamsBuilder	builder(StoreParams params)	Build StoreParams, starting from given default values.
boolean	equals(Object obj)
Integer	getBlockReadCacheSize()	Block read cache size (mmap'ed files do not have a block cache)
Integer	getBlockSize()	Block size - this is only configurable when the on-disk are created.
Integer	getBlockWriteCacheSize()	Block write cache size (mmap'ed files do not have a block cache)
static StoreParams	getDftStoreParams()	The system default settings.
FileMode	getFileMode()	File Mode
String	getIndexId2Node()
String	getIndexNode2Id()
String	getIndexPrefix()
Integer	getNode2NodeIdCacheSize()	Node cache for Node->NodeId.
Integer	getNodeId2NodeCacheSize()	Node cache for NodeId->Node.
Integer	getNodeMissCacheSize()	Node cache for recording known misses
String	getPrefixId2Node()
String[]	getPrefixIndexes()
String	getPrefixNode2Id()
String	getPrimaryIndexPrefix()
String	getPrimaryIndexQuads()
String	getPrimaryIndexTriples()
String[]	getQuadIndexes()
static StoreParams	getSmallStoreParams()	A StoreParams that provides a smaller in-JVM foot print.
String[]	getTripleIndexes()
int	hashCode()
boolean	isSetBlockReadCacheSize()
boolean	isSetBlockWriteCacheSize()
boolean	isSetFileMode()
boolean	isSetNode2NodeIdCacheSize()
boolean	isSetNodeId2NodeCacheSize()
boolean	isSetNodeMissCacheSize()
static boolean	sameValues(StoreParams params1, StoreParams params2)	Equality but ignore "isSet"
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

builder

public static StoreParamsBuilder builder()

Build StoreParams, starting from system defaults.

Returns:

StoreParamsBuilder

builder

public static StoreParamsBuilder builder(StoreParams params)

Build StoreParams, starting from given default values.

Returns:

StoreParamsBuilder

getDftStoreParams

public static StoreParams getDftStoreParams()

The system default settings. This is the normal set to use. It is the set of values used when no StoreParams is provided, which is the normal usage.

getSmallStoreParams

public static StoreParams getSmallStoreParams()

A StoreParams that provides a smaller in-JVM foot print. This is compatible with any database but it is wise to use this consistently, that is, use when created and when opened later. It reduces cache sizes and runs the database in "direct" file mode so as not to use memory mapped files in addition to the JVM space.

getFileMode

public FileMode getFileMode()

Description copied from interface: IndexParams

File Mode

Specified by:

getFileMode in interface BlockParams

Specified by:

getFileMode in interface IndexParams

Specified by:

getFileMode in interface StoreParamsDynamic

isSetFileMode

public boolean isSetFileMode()

Specified by:

isSetFileMode in interface StoreParamsDynamic

getBlockSize

public Integer getBlockSize()

Description copied from interface: IndexParams

Block size - this is only configurable when the on-disk are created. After that, the same value as at creation must be used each time.

Specified by:

getBlockSize in interface BlockParams

Specified by:

getBlockSize in interface IndexParams

getBlockReadCacheSize

public Integer getBlockReadCacheSize()

Description copied from interface: IndexParams

Block read cache size (mmap'ed files do not have a block cache)

Specified by:

getBlockReadCacheSize in interface BlockParams

Specified by:

getBlockReadCacheSize in interface IndexParams

Specified by:

getBlockReadCacheSize in interface StoreParamsDynamic

isSetBlockReadCacheSize

public boolean isSetBlockReadCacheSize()

Specified by:

isSetBlockReadCacheSize in interface StoreParamsDynamic

getBlockWriteCacheSize

public Integer getBlockWriteCacheSize()

Description copied from interface: IndexParams

Block write cache size (mmap'ed files do not have a block cache)

Specified by:

getBlockWriteCacheSize in interface BlockParams

Specified by:

getBlockWriteCacheSize in interface IndexParams

Specified by:

getBlockWriteCacheSize in interface StoreParamsDynamic

isSetBlockWriteCacheSize

public boolean isSetBlockWriteCacheSize()

Specified by:

isSetBlockWriteCacheSize in interface StoreParamsDynamic

getNode2NodeIdCacheSize

public Integer getNode2NodeIdCacheSize()

Description copied from interface: StoreParamsDynamic

Node cache for Node->NodeId.

Specified by:

getNode2NodeIdCacheSize in interface StoreParamsDynamic

isSetNodeId2NodeCacheSize

public boolean isSetNodeId2NodeCacheSize()

Specified by:

isSetNodeId2NodeCacheSize in interface StoreParamsDynamic

isSetNode2NodeIdCacheSize

public boolean isSetNode2NodeIdCacheSize()

Specified by:

isSetNode2NodeIdCacheSize in interface StoreParamsDynamic

getNodeId2NodeCacheSize

public Integer getNodeId2NodeCacheSize()

Description copied from interface: StoreParamsDynamic

Node cache for NodeId->Node. Important for SPARQL results.

Specified by:

getNodeId2NodeCacheSize in interface StoreParamsDynamic

getNodeMissCacheSize

public Integer getNodeMissCacheSize()

Description copied from interface: StoreParamsDynamic

Node cache for recording known misses

Specified by:

getNodeMissCacheSize in interface StoreParamsDynamic

isSetNodeMissCacheSize

public boolean isSetNodeMissCacheSize()

Specified by:

isSetNodeMissCacheSize in interface StoreParamsDynamic

getIndexNode2Id

public String getIndexNode2Id()

getIndexId2Node

public String getIndexId2Node()

getPrimaryIndexTriples

public String getPrimaryIndexTriples()

getTripleIndexes

public String[] getTripleIndexes()

getPrimaryIndexQuads

public String getPrimaryIndexQuads()

getQuadIndexes

public String[] getQuadIndexes()

getPrimaryIndexPrefix

public String getPrimaryIndexPrefix()

getPrefixIndexes

public String[] getPrefixIndexes()

getIndexPrefix

public String getIndexPrefix()

getPrefixNode2Id

public String getPrefixNode2Id()

getPrefixId2Node

public String getPrefixId2Node()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

sameValues

public static boolean sameValues(StoreParams params1,
 StoreParams params2)

Equality but ignore "isSet"

equals

public boolean equals(Object obj)

Overrides:

equals in class Object