org.mmbase.storage

Class Attributes

java.lang.Object

org.mmbase.storage.Attributes

public final class Attributes
extends Object

This class defines the attributes names used by the standard storage manager classes. Specific storage managers may ignore or add their own attributes.

Since:

MMBase-1.7

Version:

$Id$

Author:

Pierre van Rooden

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_STORAGE_IDENTIFIER_PREFIX Attribute: default-storage-identifier-prefix.
static String	DISALLOWED_FIELD_CASE_SENSITIVE Option: disallowed-fields-case-sensitive.
static String	ENFORCE_DISALLOWED_FIELDS Option: enforce.disallowed.fields.
static String	GET_SURROGATOR This attribute can be used to specify a CharTransformer class of which an instance will be used to filter strings which are fetched from the database.
static String	MAX_IDENTIFIER_LENGTH This attribute can be used to specify the maximum identifier length for table names and key names.
static String	SET_SURROGATOR This attribute can be used to specify a CharTransformer class of which an instance will be used to filter strings which are set into the database.
static String	STORAGE_IDENTIFIER_CASE Attribute: storage-identifier-case.

Constructor Summary

Constructors

Constructor and Description
Attributes()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

DISALLOWED_FIELD_CASE_SENSITIVE

public static final String DISALLOWED_FIELD_CASE_SENSITIVE

Option: disallowed-fields-case-sensitive. if true, matching MMBase fieldnames with the disallowed fieldnames list is case-sensitive. By default, this option is false. Note that you can specify this attribute seperately, but the "case-sensitive" attribute of the "disallowedfields" tag overrides this attribute.

See Also:

Constant Field Values

ENFORCE_DISALLOWED_FIELDS

public static final String ENFORCE_DISALLOWED_FIELDS

Option: enforce.disallowed.fields. if true, the storage layer alwyas fails when encountering fieldnames that are reserved sql keywords, and for which no alternate name is available. If false, the layer will ignore the restriction and attempt to use the reserved word (leaving any errors to the underlying implementation).
By default, this option is false. Note that you can specify this attribute seperately, but the "enforce" attribute of the "disallowedfields" tag overrides this attribute.

See Also:

Constant Field Values

STORAGE_IDENTIFIER_CASE

public static final String STORAGE_IDENTIFIER_CASE

Attribute: storage-identifier-case. if set, the storage identifiers for builders and fieldnames are converted to lowercase (if the value is 'lower') or uppercase (if the value is 'upper') before they are passed to the storage manager. If you specify another value this attribute is ignored. This ensures that field or builder names that differ only by case will return the same storage identifier (and thus point to the same storage element). You may need to set this value for some specific storage implementations. I.e. some databases expect table or fieldname to be case sensitive, or expect them to be uppercase. By default, this option is not set.

See Also:

Constant Field Values

DEFAULT_STORAGE_IDENTIFIER_PREFIX

public static final String DEFAULT_STORAGE_IDENTIFIER_PREFIX

Attribute: default-storage-identifier-prefix. A default prefix to place in front of diallowed fieldnames to make them suitabel for use in a storage layer. By default, this option is not set.

See Also:

Constant Field Values

SET_SURROGATOR

public static final String SET_SURROGATOR

This attribute can be used to specify a CharTransformer class of which an instance will be used to filter strings which are set into the database.

Since:

MMBase-1.7.4

See Also:

Constant Field Values

GET_SURROGATOR

public static final String GET_SURROGATOR

This attribute can be used to specify a CharTransformer class of which an instance will be used to filter strings which are fetched from the database.

Since:

MMBase-1.7.4

See Also:

Constant Field Values

MAX_IDENTIFIER_LENGTH

public static final String MAX_IDENTIFIER_LENGTH

This attribute can be used to specify the maximum identifier length for table names and key names.

Since:

MMBase-1.8.0

See Also:

Constant Field Values

Constructor Detail

Attributes

public Attributes()