Package com.appliedolap.essbase

Record Class EssCubeView.DimensionPlacement

java.lang.Object

java.lang.Record

com.appliedolap.essbase.EssCubeView.DimensionPlacement

Record Components:

name - the dimension's name

region - which of the grid's three regions it occupies

index - the grid row it occupies for EssCubeView.DimensionPlacement.Region.TOP, the grid column for EssCubeView.DimensionPlacement.Region.LEFT, and -1 for EssCubeView.DimensionPlacement.Region.POV

Enclosing interface:

EssCubeView

public static record EssCubeView.DimensionPlacement(String name, EssCubeView.DimensionPlacement.Region region, int index)
extends Record

Where a dimension sits in the grid: in the POV, on a top/column axis, or on a left/row axis.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EssCubeView.DimensionPlacement.Region	A grid's three regions.

Constructor Summary

Constructors

Constructor	Description
DimensionPlacement(String name, EssCubeView.DimensionPlacement.Region region, int index)	Creates an instance of a DimensionPlacement record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
int	index()	Returns the value of the index record component.
String	name()	Returns the value of the name record component.
EssCubeView.DimensionPlacement.Region	region()	Returns the value of the region record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

DimensionPlacement

public DimensionPlacement(String name,
 EssCubeView.DimensionPlacement.Region region,
 int index)

Creates an instance of a DimensionPlacement record class.

Parameters:

name - the value for the name record component

region - the value for the region record component

index - the value for the index record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

region

public EssCubeView.DimensionPlacement.Region region()

Returns the value of the region record component.

Returns:

the value of the region record component

index

public int index()

Returns the value of the index record component.

Returns:

the value of the index record component