Skip navigation links

com.essbase.eas.essbase.defs.outline
Class AliasTable

java.lang.Object
com.essbase.eas.essbase.defs.outline.AliasTable

All Implemented Interfaces:

java.io.Serializable

public class AliasTable

extends java.lang.Object

implements java.io.Serializable

simple definition of an alias table.

Since:

6.5.1

Version:

7.0.0

Author:

Hank Cox

See Also:

Serialized Form

Field Summary

static short	ALIAS_TABLE_MAX_LEN contains the maximum length for an alias table name.
static byte	ALIAS_TABLE_NAME_DUPLICATE value used by validation routine if an alias table name is a duplicate
static byte	ALIAS_TABLE_NAME_EMPTY value used by validation routine if an alias table name is empty or null
static byte	ALIAS_TABLE_NAME_OK value used by validation routine if an alias table name is ok.
static byte	ALIAS_TABLE_NAME_TOO_LONG value used by validation routine if an alias table name is too long

Constructor Summary

AliasTable()
constructs an alias table with no values.

AliasTable(java.lang.String n)
constructs an alias table with a specific name.

AliasTable(java.lang.String n, boolean def)
constructs an alias table with the requested name and default table setting.

Method Summary

void	clear() clears internal data
java.lang.String	getName() gets the name property.
boolean	isDefaultTable() retrieves the defaulttable property.
void	setDefaultTable(boolean value) sets the defaultTable property.
void	setName(java.lang.String value) sets the name property.
java.lang.String	toString()
static byte	validateName(java.lang.String value) checks an alias table name for validity.
static byte	validateName(java.lang.String value, AliasTable[] tables) checks an alias table name for validity.

Methods inherited from class java.lang.Object

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

Field Detail

ALIAS_TABLE_NAME_OK

public static final byte ALIAS_TABLE_NAME_OK

value used by validation routine if an alias table name is ok.

See Also:

Constant Field Values

ALIAS_TABLE_NAME_EMPTY

public static final byte ALIAS_TABLE_NAME_EMPTY

value used by validation routine if an alias table name is empty or null

See Also:

Constant Field Values

ALIAS_TABLE_NAME_TOO_LONG

public static final byte ALIAS_TABLE_NAME_TOO_LONG

value used by validation routine if an alias table name is too long

See Also:

Constant Field Values

ALIAS_TABLE_NAME_DUPLICATE

public static final byte ALIAS_TABLE_NAME_DUPLICATE

value used by validation routine if an alias table name is a duplicate

See Also:

Constant Field Values

ALIAS_TABLE_MAX_LEN

public static final short ALIAS_TABLE_MAX_LEN

contains the maximum length for an alias table name.

See Also:

Constant Field Values

Constructor Detail

AliasTable

public AliasTable()

constructs an alias table with no values. An alias table constructed this way wouldn't normally be considered legitimate; however, this constructor is public so that alias table objects can be transported via the generic xml transport mechanism.

AliasTable

public AliasTable(java.lang.String n)

constructs an alias table with a specific name.

AliasTable

public AliasTable(java.lang.String n,
                  boolean def)

constructs an alias table with the requested name and default table setting.

Method Detail

validateName

public static byte validateName(java.lang.String value)

checks an alias table name for validity. Returns one of the ALIAS_TABLE_NAME_* values.

validateName

public static byte validateName(java.lang.String value,
                                AliasTable[] tables)

checks an alias table name for validity. Returns one of the ALIAS_TABLE_NAME_* values.

isDefaultTable

public boolean isDefaultTable()

retrieves the defaulttable property.

setDefaultTable

public void setDefaultTable(boolean value)

sets the defaultTable property.

getName

public java.lang.String getName()

gets the name property.

setName

public void setName(java.lang.String value)

sets the name property.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clear

public void clear()

clears internal data

Skip navigation links