public abstract class SortInfo
extends java.lang.Object
implements oracle.dss.util.parameters.ParameterUser
Modifier and Type | Field and Description |
---|---|
static int |
ASCENDING
A sort direction that specifies sorting in ascending order.
|
static int |
DESCENDING
A sort direction that specifies sorting in descending order.
|
static int |
FIRST
A constant for slice based sorts indicating that the opposite edge
should be sorted based on the first slice in the data body.
|
static int |
LAST
A constant for slice based sorts indicating that the opposite edge
should be sorted based on the last slice in the data body.
|
protected int[] |
m_direction |
protected java.lang.String |
m_layerName |
protected oracle.dss.util.parameters.ParameterUserHelper |
m_parameterHelper |
Constructor and Description |
---|
SortInfo()
Constructor
|
SortInfo(java.lang.String layerName,
int[] direction)
Constructor
|
Modifier and Type | Method and Description |
---|---|
void |
associateParameter(java.lang.Object field,
oracle.dss.util.parameters.Parameter parameter)
Associates a parameter with a field or other object-specific
identifier in the ParameterUser object
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getAssociatedParameterName(java.lang.Object field)
Returns the association of a Parameter with a given field or other
object-specific identifier.
|
int[] |
getDirection()
Get the array of direction constants that specify the sort
direction of dimension items.
|
java.lang.String |
getLayerName()
Get the name of the layer to which these sort criteria apply.
|
java.lang.String[] |
getParameterNames()
Returns the names of all Parameters that are used by this Object.
|
void |
parameterize(oracle.dss.util.parameters.ParameterManager pm) |
void |
setDirection(int[] direction)
Set one or more direction constants that specify the
sort direction of each corresponding sort
criterion.
|
void |
setLayerName(java.lang.String layerName)
Set the layer name to which these sort crtieria apply.
|
boolean |
usesParameter(oracle.dss.util.parameters.Parameter parameter)
Indicates whether the specified Parameter is being used by this Object.
|
protected int[] m_direction
protected java.lang.String m_layerName
protected oracle.dss.util.parameters.ParameterUserHelper m_parameterHelper
public static final int ASCENDING
public static final int DESCENDING
public static final int FIRST
public static final int LAST
public SortInfo()
public SortInfo(java.lang.String layerName, int[] direction)
layerName
- name of the layer to which these sort criteria applydirection
- Array of QDR objects by which to sort.public void setLayerName(java.lang.String layerName)
layerName
- name of the layer to which these sort criteria applypublic java.lang.String getLayerName()
public void setDirection(int[] direction)
direction
- Array of QDR objects by which to sort.public int[] getDirection()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public boolean usesParameter(oracle.dss.util.parameters.Parameter parameter)
oracle.dss.util.parameters.ParameterUser
usesParameter
in interface oracle.dss.util.parameters.ParameterUser
parameter
- The specified Parameterpublic java.lang.String[] getParameterNames()
oracle.dss.util.parameters.ParameterUser
getParameterNames
in interface oracle.dss.util.parameters.ParameterUser
public void associateParameter(java.lang.Object field, oracle.dss.util.parameters.Parameter parameter)
oracle.dss.util.parameters.ParameterUser
associateParameter
in interface oracle.dss.util.parameters.ParameterUser
field
- name or other object-specific ID of the
item with which to associate the parameterparameter
- The parameter to associate with fieldpublic java.lang.String getAssociatedParameterName(java.lang.Object field)
oracle.dss.util.parameters.ParameterUser
getAssociatedParameterName
in interface oracle.dss.util.parameters.ParameterUser
field
- Field name or other object-specific item within the objectpublic void parameterize(oracle.dss.util.parameters.ParameterManager pm)