Package com.activeviam.copper

Class HierarchyIdentifier

java.lang.Object

com.activeviam.copper.HierarchyIdentifier

All Implemented Interfaces:

Serializable

public class HierarchyIdentifier
extends Object
implements Serializable

The identifier of a hierarchy in a cube.

Author:

ActiveViam

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static char	DESCRIPTION_ESCAPING_CHAR	Used to escape DESCRIPTION_SEPARATOR.
static char	DESCRIPTION_SEPARATOR	Used to generate a String representation of HierarchyIdentifier and LevelIdentifier.
String	dimension	The name of the dimension containing the hierarchy.
String	hierarchy	The name of the hierarchy.

Constructor Summary

Constructors

Constructor	Description
HierarchyIdentifier(String dimension, String hierarchy)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static HierarchyIdentifier	fromDescription(@NonNull String description)	Parses a description to convert it to a HierarchyIdentifier.
int	hashCode()
static HierarchyIdentifier	simple(String hierarchy)	Creates a hierarchy identifier for simple hierarchy where the dimension and hierarchy share the same name.
String	toDescription()	Produces a description that can be used in post-processors definitions.
static String	toDescription(String dimension, String hierarchy)	Produces a description that can be used in post-processors definitions.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

DESCRIPTION_SEPARATOR

public static final char DESCRIPTION_SEPARATOR

Used to generate a String representation of HierarchyIdentifier and LevelIdentifier.

See Also:

Constant Field Values

DESCRIPTION_ESCAPING_CHAR

public static final char DESCRIPTION_ESCAPING_CHAR

Used to escape DESCRIPTION_SEPARATOR.

See Also:

Constant Field Values

dimension

public final String dimension

The name of the dimension containing the hierarchy.

hierarchy

public final String hierarchy

The name of the hierarchy.

Constructor Detail

HierarchyIdentifier

public HierarchyIdentifier(String dimension,
                           String hierarchy)

Constructor.

Parameters:

dimension - the name of the dimension containing the hierarchy

hierarchy - the name of the hierarchy

Method Detail

simple

public static HierarchyIdentifier simple(String hierarchy)

Creates a hierarchy identifier for simple hierarchy where the dimension and hierarchy share the same name.

Parameters:

hierarchy - name of the hierarchy (and dimension)

Returns:

created coordinate

toDescription

public String toDescription()

Produces a description that can be used in post-processors definitions.

Returns:

the description

toDescription

public static String toDescription(String dimension,
                                   String hierarchy)

Produces a description that can be used in post-processors definitions.

Parameters:

dimension - the name of the dimension containing the hierarchy

hierarchy - the name of the hierarchy

Returns:

the description

fromDescription

public static HierarchyIdentifier fromDescription(@NonNull
                                                  @NonNull String description)

Parses a description to convert it to a HierarchyIdentifier.

Parameters:

description - the description

Returns:

the corresponding coordinate

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object