Skip navigation links

com.essbase.eas.essbase.defs.outline
Class Consolidation

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

All Implemented Interfaces:

XmlRepresentable, java.io.Serializable, java.lang.Cloneable

public final class Consolidation

extends java.lang.Object

implements java.lang.Cloneable, java.io.Serializable, XmlRepresentable

This class encapsulates the Essbase outline concept of consolidation rules. It is patterned after the java.awt.Color class.

Since:

6.5.1

Version:

7.0.0

Author:

Hank Cox

See Also:

Serialized Form

Field Summary

static short	ADD_VALUE
static Consolidation	ADDITION
static short	ADDITION_ALLOWED
static short	ADDITION_IGNORE_ALLOWED
static java.lang.String	ADDITION_KEY
static short	ALL_ALLOWED
static short	DIV_VALUE
static Consolidation	DIVISION
static java.lang.String	DIVISION_KEY
static short	IGNORE_ALLOWED
static short	MULT_VALUE
static Consolidation	MULTIPLICATION
static java.lang.String	MULTIPLICATION_KEY
static Consolidation	NEVER
static java.lang.String	NEVER_KEY
static short	NEVER_VALUE
static Consolidation	NOOP
static java.lang.String	NOOP_KEY
static short	NOOP_VALUE
static Consolidation	PERCENT
static java.lang.String	PERCENT_KEY
static short	PERCENT_VALUE
static short	SUB_VALUE
static Consolidation	SUBTRACTION
static java.lang.String	SUBTRACTION_KEY

Constructor Summary

Consolidation()

Consolidation(short value)

Consolidation(java.lang.String value)

Method Summary

java.lang.Object	clone()
boolean	equals(java.lang.Object obj)
static Consolidation	getObjectFor(Consolidation value)
static Consolidation	getObjectFor(short value)
java.lang.Object	getObjectForXMLValue(java.lang.Object o)
short	getValue()
java.lang.Object	getXMLValue()
void	setValue(short value)
java.lang.String	toDisplayString()
java.lang.String	toLongDisplayString()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ADD_VALUE

public static final short ADD_VALUE

See Also:

Constant Field Values

SUB_VALUE

public static final short SUB_VALUE

See Also:

Constant Field Values

MULT_VALUE

public static final short MULT_VALUE

See Also:

Constant Field Values

DIV_VALUE

public static final short DIV_VALUE

See Also:

Constant Field Values

PERCENT_VALUE

public static final short PERCENT_VALUE

See Also:

Constant Field Values

NOOP_VALUE

public static final short NOOP_VALUE

See Also:

Constant Field Values

NEVER_VALUE

public static final short NEVER_VALUE

See Also:

Constant Field Values

ALL_ALLOWED

public static final short ALL_ALLOWED

See Also:

Constant Field Values

ADDITION_ALLOWED

public static final short ADDITION_ALLOWED

See Also:

Constant Field Values

IGNORE_ALLOWED

public static final short IGNORE_ALLOWED

See Also:

Constant Field Values

ADDITION_IGNORE_ALLOWED

public static final short ADDITION_IGNORE_ALLOWED

See Also:

Constant Field Values

ADDITION

public static final Consolidation ADDITION

SUBTRACTION

public static final Consolidation SUBTRACTION

MULTIPLICATION

public static final Consolidation MULTIPLICATION

DIVISION

public static final Consolidation DIVISION

PERCENT

public static final Consolidation PERCENT

NOOP

public static final Consolidation NOOP

NEVER

public static final Consolidation NEVER

ADDITION_KEY

public static final java.lang.String ADDITION_KEY

See Also:

Constant Field Values

SUBTRACTION_KEY

public static final java.lang.String SUBTRACTION_KEY

See Also:

Constant Field Values

MULTIPLICATION_KEY

public static final java.lang.String MULTIPLICATION_KEY

See Also:

Constant Field Values

DIVISION_KEY

public static final java.lang.String DIVISION_KEY

See Also:

Constant Field Values

PERCENT_KEY

public static final java.lang.String PERCENT_KEY

See Also:

Constant Field Values

NOOP_KEY

public static final java.lang.String NOOP_KEY

See Also:

Constant Field Values

NEVER_KEY

public static final java.lang.String NEVER_KEY

See Also:

Constant Field Values

Constructor Detail

Consolidation

public Consolidation()

Consolidation

public Consolidation(short value)

Consolidation

public Consolidation(java.lang.String value)

Method Detail

getValue

public short getValue()

setValue

public void setValue(short value)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toDisplayString

public java.lang.String toDisplayString()

toLongDisplayString

public java.lang.String toLongDisplayString()

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

getObjectFor

public static Consolidation getObjectFor(Consolidation value)

getObjectFor

public static Consolidation getObjectFor(short value)

getXMLValue

public java.lang.Object getXMLValue()

Specified by:

getXMLValue in interface XmlRepresentable

getObjectForXMLValue

public java.lang.Object getObjectForXMLValue(java.lang.Object o)

Specified by:

getObjectForXMLValue in interface XmlRepresentable

Skip navigation links