oracle.epm.fm.domainobject.pov

Class Slice

java.lang.Object

oracle.epm.fm.domainobject.pov.Slice

All Implemented Interfaces:

Serializable

public class Slice
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Slice()
Slice(List<Dimension> dimensionsToInit)
Slice(List<Dimension> dimensionsToInit, String stringInputFormat)
Slice(List<Dimension> dimensionsToInit, String stringInputFormat, boolean removeNoMbrDims)
Slice(List<Dimension> dimensionsToInit, String stringInputFormat, boolean removeNoMbrDims, boolean validateSpecialChar)
Slice(Slice slice)

Method Summary

Modifier and Type	Method and Description
void	addMember(Dimension dimension, String name) Adds a new Dimension and sets the POV member for the dimension in the slice.
void	addMembers(Dimension dimension, List<String> members) Adds a new Dimension with the list of memebrs.
List<String>	getAsPOVStrings()
String	getConstraint(String dimensionName)
String	getConstraintString()
Dimension	getDimension(DIMENSIONTYPE dimensionType)
List<String>	getDimensionNames() returns names of all the dimensions that Slice has.
List<Dimension>	getDimensions() returns cloned dimensions that Slice has.
static List<Dimension>	getDimsToInit(String povExpression, List<Dimension> dimensions)
String	getMember(DIMENSIONTYPE type) returns the the first member, that is the POV value as a String
String	getMember(String dimensionName) returns the the first member, that is the POV value as a String
List<String>	getMembers(String dimensionName) returns all the members as an array list for a dimension
LinkedHashMap<String,String>	getPOV() returns the Slice as LinkedHashMap.
String	getPOVString() returns the POV as HFM format String.
String	getSliceAsString() returns the Slice as HFM format String.
String	getSliceAsStringEx()
String	getString(String dimensionName) returns the the first member, in HFM string format
String	getString(String dimensionName, boolean allMembers) returns the HFM format with all the members for the dimension if allMembers is true.
boolean	hasEmptyMembers() Validate if if all the dimensions has members
void	insertMember(Dimension dimension, String name, DIMENSIONTYPE insertAfter) Insert a new Dimension after indertAfter and sets the POV member for the dimension in the slice.
boolean	isSelectable(String dimensionName)
void	merge(Slice slice) This will replace the members from source slice to background pov
void	merge(Slice slice, List<String> exceptions) This will replace the members from source slice to background pov
void	mergeIfEmpty(Slice slice) This will copy to the destination only if destination is empty
void	mergeWithEmpty(Slice slice) This will replace the members from source slice to background pov taking empty member list also if dimension is present
void	removeDimension(Dimension dimension)
void	removeDimension(String dimensionName)
void	removeDimensionOld(String dimensionName) Deprecated.
void	setMember(String dimensionName, String name) Sets the member for the dimensionName as the POV member to the slice.
void	setMember(String dimensionName, String name, boolean povMember) Adds the member for the dimensionName to the slice.
void	setMembers(String dimensionName, List<String> members) Sets the member list for the dimensionName with the new list in the slice.
void	setSelectable(String dimensionName, boolean bSelectable)
void	setSelectableList(String dimensionName, String memberList)
void	setSelectableString(String inputString)
void	setString(Dimension dimension, String value)
void	setString(String dimensionName, String value)

Methods inherited from class java.lang.Object

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

Constructor Detail

Slice

public Slice()

Slice

public Slice(List<Dimension> dimensionsToInit)

Slice

public Slice(List<Dimension> dimensionsToInit,
             String stringInputFormat)

Slice

public Slice(List<Dimension> dimensionsToInit,
             String stringInputFormat,
             boolean removeNoMbrDims)
      throws HFMException

Throws:

HFMException

Slice

public Slice(List<Dimension> dimensionsToInit,
             String stringInputFormat,
             boolean removeNoMbrDims,
             boolean validateSpecialChar)
      throws HFMException

Throws:

HFMException

Slice

public Slice(Slice slice)

Method Detail

isSelectable

public boolean isSelectable(String dimensionName)

setSelectable

public void setSelectable(String dimensionName,
                          boolean bSelectable)

removeDimension

public void removeDimension(Dimension dimension)

removeDimensionOld

@Deprecated
public void removeDimensionOld(String dimensionName)

Deprecated.

This was the way we were orginally removing from the object, but was causing an exception

Parameters:

dimensionName -

removeDimension

public void removeDimension(String dimensionName)

setString

public void setString(String dimensionName,
                      String value)

setString

public void setString(Dimension dimension,
                      String value)

setMember

public void setMember(String dimensionName,
                      String name)

Sets the member for the dimensionName as the POV member to the slice. dimensionName must exist in the dimension list specified while creating this slice

Parameters:

dimensionName - the dimension name for which the member to be set.

name - the name of the member for the dimensionName

setMember

public void setMember(String dimensionName,
                      String name,
                      boolean povMember)

Adds the member for the dimensionName to the slice. dimensionName must exist in the dimension list specified while creating this slice

Parameters:

dimensionName - the dimension name for which the member to be set.

name - the name of the member for the dimensionName

povMember - if true , name is set as the POV member in the slice

insertMember

public void insertMember(Dimension dimension,
                         String name,
                         DIMENSIONTYPE insertAfter)

Insert a new Dimension after indertAfter and sets the POV member for the dimension in the slice. If the dimension is already specified while creating this Slice, will replace the dimension. Dimension will not be added if insertAfter not found

Parameters:

dimension - the dimension to be added.

name - the name of the member for the dimension

insertAfter - the dimension type after which new Diemnsion has to be inserted

addMember

public void addMember(Dimension dimension,
                      String name)

Adds a new Dimension and sets the POV member for the dimension in the slice. If the dimension is already specified while creating this Slice, will replace the dimension.

Parameters:

dimension - the dimension to be added.

name - the name of the member for the dimension

setMembers

public void setMembers(String dimensionName,
                       List<String> members)

Sets the member list for the dimensionName with the new list in the slice. dimensionName must exist in the dimension list specified while creating this slice. The first member in the list becomes the pov member

Parameters:

dimensionName - the dimension name for which the member to be set.

members - new member list for the dimensionName

addMembers

public void addMembers(Dimension dimension,
                       List<String> members)

Adds a new Dimension with the list of memebrs. Sets the first member in the list as POV member for the dimension in the slice. If the dimension is already specified while creating this Slice, will replace the dimension.

Parameters:

dimension - the dimension to be added.

members - the name of the member for the dimension

getMembers

public List<String> getMembers(String dimensionName)

returns all the members as an array list for a dimension

Parameters:

dimensionName - the dimension name for which the member to be set.

Returns:

returns the members as an array list for a dimension

getMember

public String getMember(String dimensionName)

returns the the first member, that is the POV value as a String

Parameters:

dimensionName - the dimension name for which the member to be set.

Returns:

the the first member, that is the POV value as a String

getMember

public String getMember(DIMENSIONTYPE type)

returns the the first member, that is the POV value as a String

Parameters:

type - the dimension type for which the member to be set.

Returns:

the the first member, that is the POV value as a String

getString

public String getString(String dimensionName)

returns the the first member, in HFM string format

Parameters:

dimensionName - the dimension name for which the member to be set.

Returns:

the first member, in HFM string format

getString

public String getString(String dimensionName,
                        boolean allMembers)

returns the HFM format with all the members for the dimension if allMembers is true. returns POV if allMembers is false

Parameters:

dimensionName - the dimension name for which the member to be set.

allMembers - the dimension name for which the member to be set.

Returns:

the HFM format with all the members for the dimension if allMembers is true

getPOV

public LinkedHashMap<String,String> getPOV()

returns the Slice as LinkedHashMap.

Returns:

returns the Slice as LinkedHashMap.

getPOVString

public String getPOVString()

returns the POV as HFM format String.

Returns:

the POV as HFM format String.

getAsPOVStrings

public List<String> getAsPOVStrings()

Returns:

Returns each pov in HFM format seprately as List of Strings

getSliceAsString

public String getSliceAsString()

returns the Slice as HFM format String.

Returns:

the Slice as HFM format String.

getSliceAsStringEx

public String getSliceAsStringEx()

getDimensionNames

public List<String> getDimensionNames()

returns names of all the dimensions that Slice has. Caller can iterate through memebrs using getMemebr

Returns:

the Slice as HFM format String.

getDimensions

public List<Dimension> getDimensions()

returns cloned dimensions that Slice has. Caller can iterate through memebrs using getMemebr

Returns:

the Slice as HFM format String.

getConstraintString

public String getConstraintString()

setSelectableList

public void setSelectableList(String dimensionName,
                              String memberList)

setSelectableString

public void setSelectableString(String inputString)

getConstraint

public String getConstraint(String dimensionName)

merge

public void merge(Slice slice)

This will replace the members from source slice to background pov

Parameters:

slice - source slice to merge

merge

public void merge(Slice slice,
                  List<String> exceptions)

This will replace the members from source slice to background pov

Parameters:

slice - source slice to merge

exceptions - list of dimension names for which the members should not be merged pass null, if all the dimensions in the slice should be merged

mergeWithEmpty

public void mergeWithEmpty(Slice slice)

This will replace the members from source slice to background pov taking empty member list also if dimension is present

Parameters:

slice - source slice to merge

mergeIfEmpty

public void mergeIfEmpty(Slice slice)

This will copy to the destination only if destination is empty

Parameters:

slice - source slice to merge

hasEmptyMembers

public boolean hasEmptyMembers()

Validate if if all the dimensions has members

Returns:

true if all the dimensions has members

getDimsToInit

public static List<Dimension> getDimsToInit(String povExpression,
                                            List<Dimension> dimensions)
                                     throws HFMException

Throws:

HFMException

getDimension

public Dimension getDimension(DIMENSIONTYPE dimensionType)

Parameters:

dimensionType -

Returns:

Dimension object if present otherwise null