|
Oracle® OLAP Java API Reference 11g Release 1 (11.1) B28128-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.olapi.metadata.BaseMetadataObject
oracle.olapi.metadata.mdm.MdmObject
oracle.olapi.metadata.mdm.MdmModel
public abstract class MdmModel
A Model
that assigns a value to an MdmAttribute
or an MdmMeasure
for a set of MdmDimension
members. The values and the MdmDimension
members are specified by the Assignment
or MdmAssignment
objects of the MdmModel
.
An Assignment
is associated with a Source
. An Assignment
is transient and exists on the client only for the duration of the session. Oracle OLAP applies the assignment when executing a query.
An MdmAssignment
is associated with an Expression
. An MdmAssignment
persists on the server. Oracle OLAP adds the assignment to the MdmModel
and writes it to the server when the application commits the transaction.
Assignment
, MdmAssignment
Constructor Summary | |
---|---|
MdmModel(MdmMetadataProvider metadataProvider) Creates an MdmModel for MDM metadata objects provided by the specified MdmMetadataProvider . |
Method Summary | |
---|---|
void |
assign(Qualification[] qualifications, Source assigned) Creates an Assignment with the default precedence and adds it to the MdmModel . |
void |
assign(Qualification[] qualifications, Source assigned, int precedence) Creates an Assignment and adds it to the MdmModel . |
void |
assign(java.lang.String[] values, Source assigned) Creates an Assignment with the default precedence and adds it to the MdmModel . |
void |
assign(java.lang.String[] values, Source assigned, int precedence) Creates an Assignment with the specified precedence and adds it to the MdmModel . |
MdmAssignment |
assign(java.lang.String lhs, Expression rhs) Gets the existing MdmAssignment , or creates a new one, for a dimension member and assigns the value of the Expression as the measure value for the member. |
void |
assign(java.lang.String value, Source assigned) Creates an Assignment with the default precedence and adds it to the MdmModel . |
void |
assign(java.lang.String value, Source assigned, int precedence) Creates an Assignment with the specified precedence and adds it to the MdmModel . |
Source |
createSolvedSource() Creates a Source that represents the results of the evaluation of the Assignment objects of the MdmModel . |
Source |
createSolvedSource(Source defaultValues) Creates a Source that represents the results of the evaluation of the Assignment objects of the MdmModel . |
MdmAssignment |
findAssignment(java.lang.String lhs) Gets the existing MdmAssignment for a dimension member. |
MdmAssignment |
findOrCreateAssignment(java.lang.String lhs) Gets the existing MdmAssignment , or creates a new one, for a dimension member. |
java.util.List |
getAssignments() Gets the Assignment objects of the MdmModel . |
int |
getDefaultPrecedence() Gets the default precedence value for the MdmModel . |
abstract java.util.List |
getInputs() Gets the Source objects that are the inputs of the MdmModel . |
java.util.List |
getMdmAssignments() Gets the MdmAssignment objects that are associated with this MdmModel . |
abstract MdmSource |
getMdmSource() Gets the MdmSource for the MdmModel . |
java.util.List |
getOutputs() Returns an empty List because an MdmModel does not have outputs. |
abstract java.util.List |
getParentModels() Gets the MdmModel objects that are the parents of the MdmModel ; the MdmModel can inherit the Assignment objects of its parents. |
abstract Source |
getType() Gets the Source that is the type of the MdmModel . |
void |
removeMdmAssignment(MdmAssignment assignment) Deletes the specified MdmAssignment from the list of MdmAssignment objects that are associated with this MdmModel . |
void |
setDefaultPrecedence(int precedence) Specifies the default precedence, which is the precedence value for Assignment objects that are created by methods that do not specify a value. |
void |
unassign(Assignment assignment) Removes an Assignment from the MdmModel . |
Methods inherited from class oracle.olapi.metadata.mdm.MdmObject |
---|
acceptVisitor, findOrCreateDescription, getDescription, getDescription, getDescription, getMetadataProvider, getName, getShortDescription, setDescription, setDescription, setDescription, setName, setShortDescription |
Methods inherited from class oracle.olapi.metadata.BaseMetadataObject |
---|
getID, getOwner |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface oracle.olapi.data.source.Model |
---|
getAutoAssignments |
Constructor Detail |
---|
public MdmModel(MdmMetadataProvider metadataProvider)
MdmModel
for MDM metadata objects provided by the specified MdmMetadataProvider
.
metadataProvider
- The MdmMetadataProvider
to use in creating the MdmModel
.Method Detail |
---|
public abstract MdmSource getMdmSource()
MdmSource
for the MdmModel
.MdmSource
for the MdmModel
.public abstract Source getType()
Source
that is the type of the MdmModel
.getType
in interface Model
Source
that is the type of the MdmModel
.public abstract java.util.List getInputs()
Source
objects that are the inputs of the MdmModel
.getInputs
in interface Model
List
of the Source
objects that are the inputs of the MdmModel
.public final java.util.List getOutputs()
List
because an MdmModel
does not have outputs. A CustomModel
can have outputs.getOutputs
in interface Model
List
.public abstract java.util.List getParentModels()
MdmModel
objects that are the parents of the MdmModel
; the MdmModel
can inherit the Assignment
objects of its parents.getParentModels
in interface Model
List
of the MdmModel
objects that are the parents of the MdmModel
.public java.util.List getAssignments()
Assignment
objects of the MdmModel
.getAssignments
in interface Model
List
of the Assignment
objects of the MdmModel
.public void assign(Qualification[] qualifications, Source assigned)
Assignment
with the default precedence and adds it to the MdmModel
.assign
in interface Model
qualifications
- An array of Qualification
objects, each of which specifies a dimension member.assigned
- A Source
that defines a value to assign as the value of a measure or attribute for the specified dimension members.public void assign(Qualification[] qualifications, Source assigned, int precedence)
Assignment
and adds it to the MdmModel
.assign
in interface Model
qualifications
- An array of Qualification
objects, each of which specifies a dimension member.assigned
- A Source
that defines a value to assign as the value of a measure or attribute for the specified dimension members.precedence
- An integer that specifies the precedence to use for the Assignment
.public void assign(java.lang.String value, Source assigned)
Assignment
with the default precedence and adds it to the MdmModel
.assign
in interface Model
value
- A String
that specifies a dimension member.assigned
- A Source
that defines a value to assign as the value of a measure or attribute for the specified dimension member.public void assign(java.lang.String value, Source assigned, int precedence)
Assignment
with the specified precedence and adds it to the MdmModel
.assign
in interface Model
value
- A String
that specifies a dimension member.assigned
- A Source
that defines a value to assign as the value of a measure or attribute for the specified dimension member.precedence
- An integer that specifies the precedence to use for the Assignment
.public void assign(java.lang.String[] values, Source assigned)
Assignment
with the default precedence and adds it to the MdmModel
.assign
in interface Model
values
- An array of String
objects that specify dimension members.assigned
- A Source
that defines a value to assign as the value of a measure or attribute for the specified dimension members.public void assign(java.lang.String[] values, Source assigned, int precedence)
Assignment
with the specified precedence and adds it to the MdmModel
.assign
in interface Model
values
- An array of String
objects that specify dimension members.assigned
- A Source
that defines a value to assign as the value of a measure or attribute for the specified dimension members.precedence
- An integer that specifies the precedence to use for the Assignment
.public void unassign(Assignment assignment)
Assignment
from the MdmModel
.unassign
in interface Model
assignment
- The Assignment
to remove.public int getDefaultPrecedence()
MdmModel
.getDefaultPrecedence
in interface Model
Assignment
objects that are created by methods that do not specify a precedence value.public void setDefaultPrecedence(int precedence)
Assignment
objects that are created by methods that do not specify a value.setDefaultPrecedence
in interface Model
precedence
- The integer value to set as the default precedence.public final Source createSolvedSource()
Source
that represents the results of the evaluation of the Assignment
objects of the MdmModel
. The elements of the returned Source
that do not have an assigned value have a value of null
.createSolvedSource
in interface Model
Source
that represents the results of the evaluation of the Assignment
objects of the Model
and that has null
for unassigned values.public final Source createSolvedSource(Source defaultValues)
Source
that represents the results of the evaluation of the Assignment
objects of the MdmModel
. The elements of the returned Source
that do not have an assigned value have the value specified by the defaultValues
Source
.createSolvedSource
in interface Model
defaultValues
- A Source
that specifies the value that you want Oracle OLAP to assign for a member of an input when the Assignment
objects of the MdmmModel
do not assign a value for the input member.Source
that represents the results of the evaluation of the Assignment
objects of the MdmModel
and that has the value of defaultValues
for unassigned values.public final MdmAssignment findAssignment(java.lang.String lhs)
MdmAssignment
for a dimension member.lhs
- A String
that contains the local value of the dimension member for the assignment.MdmAssignment
for the specified dimension member or null
if no assignment exists for the member.public final MdmAssignment findOrCreateAssignment(java.lang.String lhs)
MdmAssignment
, or creates a new one, for a dimension member.lhs
- A String
that contains the local value of the dimension member for the assignment.MdmAssignment
or a new MdmAssignment
.public final MdmAssignment assign(java.lang.String lhs, Expression rhs)
MdmAssignment
, or creates a new one, for a dimension member and assigns the value of the Expression
as the measure value for the member.lhs
- A String
that contains the local value of the dimension member for the assignment.rhs
- An Expression
that specifies the value to assign to a measure for the member.MdmAssignment
that represents the assigment of a value to a measure for a dimension member.public final void removeMdmAssignment(MdmAssignment assignment)
MdmAssignment
from the list of MdmAssignment
objects that are associated with this MdmModel
.assignment
- The MdmAssignment
to remove.public final java.util.List getMdmAssignments()
MdmAssignment
objects that are associated with this MdmModel
.List
of the MdmAssignment
objects of this MdmModel
.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |