oracle.dss.util

Class MemberSortInfo

java.lang.Object

oracle.dss.util.MemberSortInfo

public class MemberSortInfo
extends java.lang.Object

Class specifying a series of member sorts for a single dimension

Since:

release specific (what release of product did this appear in)

Field Summary

Fields

Modifier and Type	Field and Description
static int	AFTER A type of move that specifies moving a member after another member.
static int	BEFORE A type of move that specifies moving a member before another member.
static int	FIRST A type of move that specifies moving a member to the first position.
static int	LAST A type of move that specifies moving a member to the last position.

Constructor Summary

Constructors

Constructor and Description
MemberSortInfo(java.lang.String dimension) Constructor that specifies a dimension to be sorted
MemberSortInfo(java.lang.String dimension, java.lang.String[] hierarchy, java.lang.String[][] membersToMove, java.lang.String[][] memberLevels, int[] moveType, java.lang.String[] refMember, java.lang.String[] refMemberLevel) Constructor that specifies a series of member sorts

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDimension() Retrieves the dimension for all sorts
java.lang.String[]	getHierarchy() Retrieves the hierarchy for each sort
java.lang.String[][]	getMemberLevels() Specifies the levels of the members to move for each sort
java.lang.String[][]	getMembersToMove() Retrieves the members to move for each sort
int[]	getMoveType() Retrieves the type for each member sort
java.lang.String[]	getRefMember() Retrieves the name of the member relative to which the move is to occur for each sort.
java.lang.String[]	getRefMemberLevel() Retrieves the name of the relative member's level for each sort.
void	setDimension(java.lang.String dimension) Specifies the dimension for all sorts
void	setHierarchy(java.lang.String[] hierarchy) Specifies the hierarchy for each sort
void	setMemberLevels(java.lang.String[][] memberLevels) Specifies the levels of the members to move for each sort
void	setMembersToMove(java.lang.String[][] membersToMove) Specifies the members to move for each sort
void	setMoveType(int[] moveType) Specifies the type for each member sort
void	setRefMember(java.lang.String[] refMember) Specifies the name of the member relative to which the move is to occur for each sort.
void	setRefMemberLevel(java.lang.String[] refMemberLevel) Specifies the name of the relative member's level for each sort.

Methods inherited from class java.lang.Object

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

Field Detail

FIRST

public static final int FIRST

A type of move that specifies moving a member to the first position.

See Also:

Constant Field Values

LAST

public static final int LAST

A type of move that specifies moving a member to the last position.

See Also:

Constant Field Values

BEFORE

public static final int BEFORE

A type of move that specifies moving a member before another member.

See Also:

Constant Field Values

AFTER

public static final int AFTER

A type of move that specifies moving a member after another member.

See Also:

Constant Field Values

Constructor Detail

MemberSortInfo

public MemberSortInfo(java.lang.String dimension)

Constructor that specifies a dimension to be sorted

Parameters:

dimension - The name of the dimension

MemberSortInfo

public MemberSortInfo(java.lang.String dimension,
                      java.lang.String[] hierarchy,
                      java.lang.String[][] membersToMove,
                      java.lang.String[][] memberLevels,
                      int[] moveType,
                      java.lang.String[] refMember,
                      java.lang.String[] refMemberLevel)

Constructor that specifies a series of member sorts

Parameters:

dimension - The name of the dimension

Method Detail

setDimension

public void setDimension(java.lang.String dimension)

Specifies the dimension for all sorts

Parameters:

dimension - The name of the dimension

getDimension

public java.lang.String getDimension()

Retrieves the dimension for all sorts

Returns:

The name of the dimension

setHierarchy

public void setHierarchy(java.lang.String[] hierarchy)

Specifies the hierarchy for each sort

Parameters:

hierarchy - An array of hierarchies indicating the hierarchy of each specified sort

getHierarchy

public java.lang.String[] getHierarchy()

Retrieves the hierarchy for each sort

Returns:

An array of hierarchies indicating the hierarchy of each specified sort

setMembersToMove

public void setMembersToMove(java.lang.String[][] membersToMove)

Specifies the members to move for each sort

Parameters:

membersToMove - An array containing an array of member names for each sort

getMembersToMove

public java.lang.String[][] getMembersToMove()

Retrieves the members to move for each sort

Returns:

An array containing an array of member names for each sort

setMemberLevels

public void setMemberLevels(java.lang.String[][] memberLevels)

Specifies the levels of the members to move for each sort

Parameters:

memberLevels - An array containing an array of level names for each sort

getMemberLevels

public java.lang.String[][] getMemberLevels()

Specifies the levels of the members to move for each sort

Returns:

An array containing an array of level names for each sort

setMoveType

public void setMoveType(int[] moveType)

Specifies the type for each member sort

Parameters:

moveType - An array indicating the type of each specified sort The valid constants are:

• AFTER
• BEFORE
• FIRST
• LAST

See Also:

AFTER, BEFORE, FIRST, LAST

getMoveType

public int[] getMoveType()

Retrieves the type for each member sort

Returns:

An array indicating the type of each specified sort The valid constants are:

• AFTER
• BEFORE
• FIRST
• LAST

See Also:

AFTER, BEFORE, FIRST, LAST

setRefMember

public void setRefMember(java.lang.String[] refMember)

Specifies the name of the member relative to which the move is to occur for each sort. Applies only when the move type is AFTER or BEFORE.

Parameters:

newRefMember - An array containing the name of the member if the sort type is AFTER or BEFORE and null otherwise.

See Also:

AFTER, BEFORE

getRefMember

public java.lang.String[] getRefMember()

Retrieves the name of the member relative to which the move is to occur for each sort. Applies only when the move type is AFTER or BEFORE.

Returns:

An array containing the name of the member if the sort type is AFTER or BEFORE and null otherwise.

See Also:

AFTER, BEFORE

setRefMemberLevel

public void setRefMemberLevel(java.lang.String[] refMemberLevel)

Specifies the name of the relative member's level for each sort. Applies only when the move type is either AFTER or BEFORE.

Parameters:

newRefMemberLevel - An array containing the name of the member level if the sort type is AFTER or BEFORE and null otherwise.

See Also:

AFTER, BEFORE

getRefMemberLevel

public java.lang.String[] getRefMemberLevel()

Retrieves the name of the relative member's level for each sort. Applies only when the move type is either AFTER or BEFORE.

Returns:

An array containing the name of the member level if the sort type is AFTER or BEFORE and null otherwise.

See Also:

AFTER, BEFORE