org.apache.calcite.util

Class SaffronProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

org.apache.calcite.util.SaffronProperties

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

public class SaffronProperties
extends Properties

Provides an environment for debugging information, et cetera, used by saffron.

getIntProperty(java.lang.String) and getBooleanProperty(java.lang.String) are convenience methods.

It is a singleton, accessed via the instance() method. It is populated from System properties if saffron is invoked via a main() method, from a javax.servlet.ServletContext if saffron is invoked from a servlet, and so forth. If there is a file called "saffron.properties" in the current directory, it is read too.

Every property used in saffron code must have a member in this class. The member must be public and final, and be of type Property or some subtype. The javadoc comment must describe the name of the property (for example, "net.sf.saffron.connection.PoolSize") and the default value, if any. Developers, please make sure that this remains so!

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
org.eigenbase.util.property.BooleanProperty	allowInfiniteCostConverters The boolean property "saffron.opt.allowInfiniteCostConverters" determines whether the optimizer will consider adding converters of infinite cost in order to convert a relational expression from one calling convention to another.
org.eigenbase.util.property.StringProperty	defaultCharset The string property "saffron.default.charset" is the name of the default character set.
org.eigenbase.util.property.StringProperty	defaultCollation The string property "saffron.default.collation.name" is the name of the default collation.
org.eigenbase.util.property.StringProperty	defaultCollationStrength The string property "saffron.default.collation.strength" is the strength of the default collation.
org.eigenbase.util.property.StringProperty	defaultNationalCharset The string property "saffron.default.nationalcharset" is the name of the default national character set which is used with the N'string' construct which may or may not be different from the defaultCharset.

Fields inherited from class java.util.Properties

defaults

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getBooleanProperty(String key) Retrieves a boolean property.
boolean	getBooleanProperty(String key, boolean defaultValue) Retrieves a boolean property, or a default value if the property does not exist.
int	getIntProperty(String key) Retrieves an integer property.
static SaffronProperties	instance() Retrieves the singleton instance of SaffronProperties.
void	loadSaffronProperties(Properties source) Adds all saffron-related properties found in the source list.

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

allowInfiniteCostConverters

public final org.eigenbase.util.property.BooleanProperty allowInfiniteCostConverters

The boolean property "saffron.opt.allowInfiniteCostConverters" determines whether the optimizer will consider adding converters of infinite cost in order to convert a relational expression from one calling convention to another. The default value is true.

defaultCharset

public final org.eigenbase.util.property.StringProperty defaultCharset

The string property "saffron.default.charset" is the name of the default character set. The default is "ISO-8859-1". It is used in SqlValidator.

defaultNationalCharset

public final org.eigenbase.util.property.StringProperty defaultNationalCharset

The string property "saffron.default.nationalcharset" is the name of the default national character set which is used with the N'string' construct which may or may not be different from the defaultCharset. The default is "ISO-8859-1". It is used in SqlLiteral.SqlLiteral(java.lang.Object, org.apache.calcite.sql.type.SqlTypeName, org.apache.calcite.sql.parser.SqlParserPos)

defaultCollation

public final org.eigenbase.util.property.StringProperty defaultCollation

The string property "saffron.default.collation.name" is the name of the default collation. The default is "ISO-8859-1$en_US". Used in SqlCollation and SqlLiteral.SqlLiteral(java.lang.Object, org.apache.calcite.sql.type.SqlTypeName, org.apache.calcite.sql.parser.SqlParserPos)

defaultCollationStrength

public final org.eigenbase.util.property.StringProperty defaultCollationStrength

The string property "saffron.default.collation.strength" is the strength of the default collation. The default is "primary". Used in SqlCollation and SqlLiteral.SqlLiteral(java.lang.Object, org.apache.calcite.sql.type.SqlTypeName, org.apache.calcite.sql.parser.SqlParserPos)

Method Detail

instance

public static SaffronProperties instance()

Retrieves the singleton instance of SaffronProperties.

loadSaffronProperties

public void loadSaffronProperties(Properties source)

Adds all saffron-related properties found in the source list. This means all properties whose names start with "saffron." or "net.sf.saffron." The added properties can replace existing properties.

Parameters:

source - a Properties list

getBooleanProperty

public boolean getBooleanProperty(String key)

Retrieves a boolean property. Returns true if the property exists, and its value is 1, true or yes; returns false otherwise.

getBooleanProperty

public boolean getBooleanProperty(String key,
                         boolean defaultValue)

Retrieves a boolean property, or a default value if the property does not exist. Returns true if the property exists, and its value is 1, true or yes; the default value if it does not exist; false otherwise.

getIntProperty

public int getIntProperty(String key)

Retrieves an integer property. Returns -1 if the property is not found, or if its value is not an integer.