com.bigdata.btree.keys
Interface KeyBuilder.Options

All Known Subinterfaces:

AbstractTripleStore.Options, BigdataFileSystem.Options, BigdataSail.Options, LocalTripleStore.Options, TempTripleStore.Options

Enclosing class:

KeyBuilder

public static interface KeyBuilder.Options

Configuration options for DefaultKeyBuilderFactory and the KeyBuilder factory methods. The use of DefaultKeyBuilderFactory is highly recommended as it will cause the configuration to be serialized. In combination with the use of an ITupleSerializer, this means that Unicode keys for an index will be interpreted in the same manner on any machine where ITuples for that index are (de-)materialized.

Version:

$Id: KeyBuilder.java 2265 2009-10-26 12:51:06Z thompsonbry $

Author:

Bryan Thompson

Field Summary

static String	COLLATOR Optional property specifies the library that will be used to generate sort keys from Unicode data.
static String	DECOMPOSITION Optional string property whose value is one of the type safe DecompositionEnums.
static String	STRENGTH Optional string -or- integer property whose value is the strength to be set on the collator.
static String	USER_COUNTRY The pre-defined System property "user.country" determines the country for the default Locale.
static String	USER_LANGUAGE The pre-defined System property "user.language" determines the language for the default Locale.
static String	USER_VARIANT The pre-defined System property "user.variant" determines the variant for the default Locale.

Field Detail

COLLATOR

static final String COLLATOR

Optional property specifies the library that will be used to generate sort keys from Unicode data. The default always supports Unicode, but the library choice depends on whether or not ICU library is found on the classpath. When the ICU library is present, it is the default. Otherwise the JDK library is the default. You may explicitly specify the library choice using one of the CollatorEnum values. The CollatorEnum.ASCII value may be used to disable Unicode support entirely, treating the characters as if they were ASCII. If your data is not actually Unicode then this offers a substantial performance benefit.

See Also:

CollatorEnum

STRENGTH

static final String STRENGTH

Optional string -or- integer property whose value is the strength to be set on the collator. When specified, the value must be either one of the type-safe StrengthEnums -or- one of those supported by the ICU or JDK library, as appropriate. The following values are shared by both libraries:

0

Collator.PRIMARY

1

Collator.SECONDARY

2

Collator.TERTIARY

The ICU library also supports

3

Quaternary

While both libraries define IDENTICAL they use different values for this strength, hence the use of the type safe enums is recommended.

DECOMPOSITION

static final String DECOMPOSITION

Optional string property whose value is one of the type safe DecompositionEnums. The default decomposition mode will be overriden on the collator one is explicitly specified using this property.

See Also:

DecompositionEnum

USER_LANGUAGE

static final String USER_LANGUAGE

The pre-defined System property "user.language" determines the language for the default Locale.

See Also:

Locale.setDefault(Locale), http://java.sun.com/developer/technicalArticles/J2SE/locale/, Constant Field Values

USER_COUNTRY

static final String USER_COUNTRY

The pre-defined System property "user.country" determines the country for the default Locale.

See Also:

http://java.sun.com/developer/technicalArticles/J2SE/locale/, Constant Field Values

USER_VARIANT

static final String USER_VARIANT

The pre-defined System property "user.variant" determines the variant for the default Locale.

See Also:

http://java.sun.com/developer/technicalArticles/J2SE/locale/, Constant Field Values