Edit D:\app\Administrator\product\11.2.0\dbhome_1\olap\api\doc\oracle\olapi\data\source\Model.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!--NewPage--> <HTML> <HEAD> <!-- Generated by javadoc (build 1.5.0_17) on Wed Aug 12 19:50:20 UTC 2009 --> <TITLE> Model (Oracle OLAP Java API Reference) </TITLE> <META NAME="keywords" CONTENT="oracle.olapi.data.source.Model interface"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { parent.document.title="Model (Oracle OLAP Java API Reference)"; } </SCRIPT> <NOSCRIPT> </NOSCRIPT> </HEAD> <BODY BGCOLOR="white" onload="windowTitle();"> <!-- ========= START OF TOP NAVBAR ======= --> <A NAME="navbar_top"><!-- --></A> <A HREF="#skip-navbar_top" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_top_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> <b>Oracle® OLAP Java API Reference<br>11<i>g</i> Release 2 (11.2)</b><br>E10794-01<br>Beta Draft</EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../oracle/olapi/data/source/LiteralQualification.html" title="class in oracle.olapi.data.source"><B>PREV CLASS</B></A> <A HREF="../../../../oracle/olapi/data/source/NumberParameter.html" title="class in oracle.olapi.data.source"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?oracle/olapi/data/source/Model.html" target="_top"><B>FRAMES</B></A> <A HREF="Model.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_top"></A> <!-- ========= END OF TOP NAVBAR ========= --> <HR> <!-- ======== START OF CLASS DATA ======== --> <H2> <FONT SIZE="-1"> oracle.olapi.data.source</FONT> <BR> Interface Model</H2> <DL> <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../oracle/olapi/data/source/CustomModel.html" title="class in oracle.olapi.data.source">CustomModel</A>, <A HREF="../../../../oracle/olapi/metadata/mdm/MdmAttributeModel.html" title="class in oracle.olapi.metadata.mdm">MdmAttributeModel</A>, <A HREF="../../../../oracle/olapi/metadata/mdm/MdmDimensionCalculationModel.html" title="class in oracle.olapi.metadata.mdm">MdmDimensionCalculationModel</A>, <A HREF="../../../../oracle/olapi/metadata/mdm/MdmDimensionedObjectModel.html" title="class in oracle.olapi.metadata.mdm">MdmDimensionedObjectModel</A>, <A HREF="../../../../oracle/olapi/metadata/mdm/MdmMeasureModel.html" title="class in oracle.olapi.metadata.mdm">MdmMeasureModel</A>, <A HREF="../../../../oracle/olapi/metadata/mdm/MdmModel.html" title="class in oracle.olapi.metadata.mdm">MdmModel</A></DD> </DL> <HR> <DL> <DT><PRE>public interface <B>Model</B></DL> </PRE> <P> An interface for an object that represents a set of assignments that apply to a dimensioned <CODE>Source</CODE>, which is a <CODE>Source</CODE> that has one or more inputs. Each assignment specifies a calculation that supplies a value for the <CODE>Source</CODE>. The assigned value can override an existing value. <P> A <CODE>Model</CODE> can apply to a <CODE>Source</CODE> derived from one of the following: <UL> <LI>The <CODE>Source</CODE> for an <CODE>MdmDimensionedObject</CODE>. <LI>A <CODE>Source</CODE> returned by the <CODE>createSolvedSource</CODE> method of a <CODE>CustomModel</CODE>. </UL> <P> When Oracle OLAP applies a <CODE>Model</CODE> to a dimensioned <CODE>Source</CODE>, the assignments of the <CODE>Model</CODE> modify the values of that <CODE>Source</CODE>. For example, an assignment might set the value specified by one member of a dimension to be 110% of the value specified by another member of the dimension. For instance, suppose the Time dimension has a custom member that represents the year 2005. The <CODE>Model</CODE> for the Unit Price measure has an assignment that specifies that the value for 2005 is 1.1 times the value for 2004. When a query joins the <CODE>Source</CODE> for the Time dimension to the <CODE>Source</CODE> for the Unit Price measure, then Oracle OLAP assigns the calculated value as the measure value for 2005 in the <CODE>Source</CODE> that represents the results of the query. <P> An OLAP Java API <CODE>Model</CODE> is analogous to the SQL <CODE>MODEL</CODE> clause. The assignments of an OLAP Java API <CODE>Model</CODE> are analogous to the <CODE>UPDATE RULES</CODE> in the SQL <CODE>MODEL</CODE> clause. Like the SQL <CODE>MODEL</CODE> clause, the assignments in an OLAP Java API <CODE>Model</CODE> only modify values for in the context of a query; they do not change the persistant data itself. <P> The OLAP Java API provides the following implementations of the <CODE>Model</CODE> interface. <UL> <LI><CODE>MdmModel</CODE>, instances of which Oracle OLAP creates and applies to <CODE>Source</CODE> objects for <CODE>MdmMeasure</CODE> and <CODE>MdmAttribute</CODE> objects. When an application adds an assignment to an <CODE>MdmModel</CODE> and creates a query that uses the associated measure or attribute, then Oracle OLAP automatically assigns the calculated values to the results of the query. Creating a custom dimension member implicitly adds an assignment to the relevant <CODE>MdmModel</CODE>. <LI><CODE>CustomModel</CODE>, instances of which an application can create by using the <CODE>createModel</CODE> methods of a <CODE>DataProvider</CODE>. The application explicitly adds assignments to the <CODE>CustomModel</CODE>. Those assignments apply to a <CODE>Source</CODE> returned by the <CODE>createSolvedSource</CODE> method of the <CODE>CustomModel</CODE>. An application can use a <CODE>CustomModel</CODE> to implement a custom measure dimension. </UL> <P> The assignments of a <CODE>Model</CODE> are represented by <CODE>Assignment</CODE> objects. The <CODE>assign</CODE> methods of a <CODE>Model</CODE> create <CODE>Assignment</CODE> objects and add them to the <CODE>Model</CODE>. An <CODE>Assignment</CODE> has one or more <CODE>Qualification</CODE> objects and an assigned <CODE>Source</CODE>. A <CODE>Qualification</CODE> specifies an element of a <CODE>Source</CODE> that is an input of the <CODE>Model</CODE>. That <CODE>Source</CODE> is the <em>qualified</em> <CODE>Source</CODE> of the <CODE>Qualification</CODE>. The assigned <CODE>Source</CODE> provides the value that the Oracle OLAP assigns for the set of <CODE>Qualification</CODE> objects. <P> For a diagram of the <CODE>Model</CODE> class hierarchy, see <a href="doc-files/modlhier.html">Model Class Hierarchy</a>. For a diagram of the <CODE>Model</CODE> class associations, see <a href="doc-files/modelrel.html">Model Class Associations</a>. <P> The <CODE>Model</CODE> interface has accessor methods for the following operations. <UL> <LI> Getting the type, the inputs, and the outputs of the <CODE>Model</CODE>. <LI> Getting the <CODE>Assignment</CODE> objects. <LI> Getting the parent <CODE>Model</CODE> objects. <LI> Getting and setting the default precedence value. </UL> <P> The type of a <CODE>Model</CODE> is the <CODE>Source</CODE> for an OLAP Java API data type. The type of a <CODE>Model</CODE> must match the type of the <CODE>Source</CODE> to which Oracle OLAP assigns the value specified by the <CODE>Model</CODE>. The data type of the <CODE>Model</CODE> must match the data type of the value that the <CODE>Model</CODE> assigns. For example, if the type of the <CODE>Model</CODE> is Number, then the <CODE>Model</CODE> applies only to <CODE>NumberSource</CODE> objects and the <CODE>assigned</CODE> <CODE>Source</CODE> objects of the <CODE>Assignment</CODE> objects of the <CODE>Model</CODE> must be <CODE>NumberSource</CODE> objects. <P> An input of a <CODE>Model</CODE> is the <CODE>Source</CODE> object for a dimension or list that has the elements for which the <CODE>Model</CODE> specifies a value. A <CODE>Model</CODE> has an input for each <CODE>Source</CODE> that is the type or is an input of the <CODE>Source</CODE> for the <CODE>Model</CODE>. If the <CODE>Model</CODE> has more than one input, then adding an <CODE>Assignment</CODE> to it requires the use of an <CODE>assign</CODE> method that takes an array of <CODE>Qualification</CODE> objects or of <CODE>String</CODE> values. <P> An output of a <CODE>Model</CODE> is also a <CODE>Source</CODE> object. For more information on outputs, see <CODE><A HREF="../../../../oracle/olapi/data/source/CustomModel.html" title="class in oracle.olapi.data.source"><CODE>CustomModel</CODE></A></CODE>. <P> The <CODE>getAssignments</CODE> method gets the <CODE>Assignment</CODE> objects of a <CODE>Model</CODE>. The <CODE>getAutoAssignments</CODE> method gets the <CODE>Assignment</CODE> objects that Oracle OLAP automatically creates for the <CODE>Model</CODE>. For more information on automatically created <CODE>Assignment</CODE> objects, see <CODE><A HREF="../../../../oracle/olapi/metadata/mdm/MdmDimensionCalculationModel.html" title="class in oracle.olapi.metadata.mdm"><CODE>MdmDimensionCalculationModel</CODE></A></CODE>. <P> A <CODE>Model</CODE> can inherit the <CODE>Assignment</CODE> objects of a parent <CODE>Model</CODE>. For information on parent <CODE>Model</CODE> objects, see <CODE>CustomModel</CODE> and <CODE><A HREF="../../../../oracle/olapi/metadata/mdm/MdmMeasureModel.html" title="class in oracle.olapi.metadata.mdm"><CODE>MdmMeasureModel</CODE></A></CODE>. <P> The precedence values of the <CODE>Assignment</CODE> objects of a <CODE>Model</CODE> affect the order in which Oracle OLAP calculates and assigns their values. Oracle OLAP evaluates an <CODE>Assignment</CODE> with a higher precedence value before an <CODE>Assignment</CODE> with a lower value. <P> <CODE>Model</CODE> objects require the use of unique dimension hierarchy member values. For more information on unique and local dimension hierarchy values, see the Overview. <P> <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../oracle/olapi/metadata/mdm/MdmMeasure.html" title="class in oracle.olapi.metadata.mdm"><CODE>MdmMeasure</CODE></A>, <A HREF="../../../../oracle/olapi/metadata/mdm/MdmStandardMember.html" title="class in oracle.olapi.metadata.mdm"><CODE>MdmStandardMember</CODE></A></DL> <HR> <P> <!-- ========== METHOD SUMMARY =========== --> <A NAME="method_summary"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> <B>Method Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/data/source/Model.html#assign(oracle.olapi.data.source.Qualification[], oracle.olapi.data.source.Source)">assign</A></B>(<A HREF="../../../../oracle/olapi/data/source/Qualification.html" title="class in oracle.olapi.data.source">Qualification</A>[] qualifications, <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A> assigned)</CODE> <BR> Creates an <CODE>Assignment</CODE> with the default precedence and adds it to the <CODE>Model</CODE>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/data/source/Model.html#assign(oracle.olapi.data.source.Qualification[], oracle.olapi.data.source.Source, int)">assign</A></B>(<A HREF="../../../../oracle/olapi/data/source/Qualification.html" title="class in oracle.olapi.data.source">Qualification</A>[] qualifications, <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A> assigned, int precedence)</CODE> <BR> Creates an <CODE>Assignment</CODE> with the specified precedence and adds it to the <CODE>Model</CODE>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/data/source/Model.html#assign(java.lang.String[], oracle.olapi.data.source.Source)">assign</A></B>(java.lang.String[] values, <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A> assigned)</CODE> <BR> Creates an <CODE>Assignment</CODE> with the default precedence and adds it to the <CODE>Model</CODE>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/data/source/Model.html#assign(java.lang.String[], oracle.olapi.data.source.Source, int)">assign</A></B>(java.lang.String[] values, <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A> assigned, int precedence)</CODE> <BR> Creates an <CODE>Assignment</CODE> with the specified precedence and adds it to the <CODE>Model</CODE>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/data/source/Model.html#assign(java.lang.String, oracle.olapi.data.source.Source)">assign</A></B>(java.lang.String value, <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A> assigned)</CODE> <BR> Creates an <CODE>Assignment</CODE> with the default precedence and adds it to the <CODE>Model</CODE>; use this method for a <CODE>Model</CODE> that has only one input.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/data/source/Model.html#assign(java.lang.String, oracle.olapi.data.source.Source, int)">assign</A></B>(java.lang.String value, <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A> assigned, int precedence)</CODE> <BR> Creates an <CODE>Assignment</CODE> with the specified precedence and adds it to the <CODE>Model</CODE>; use this method for a <CODE>Model</CODE> that has only one input.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/data/source/Model.html#createSolvedSource()">createSolvedSource</A></B>()</CODE> <BR> Creates a <CODE>Source</CODE> that represents the results of the evaluation of the <CODE>Assignment</CODE> objects of the <CODE>Model</CODE>; elements of the returned <CODE>Source</CODE> that do not have an assigned value have a value of <CODE>null</CODE>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/data/source/Model.html#createSolvedSource(oracle.olapi.data.source.Source)">createSolvedSource</A></B>(<A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A> defaultValues)</CODE> <BR> Creates a <CODE>Source</CODE> that represents the results of the evaluation of the <CODE>Assignment</CODE> objects of the <CODE>Model</CODE>; elements of the returned <CODE>Source</CODE> that do not have an assigned value have the value specified by the <CODE>defaultValues</CODE> <CODE>Source</CODE>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.List</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/data/source/Model.html#getAssignments()">getAssignments</A></B>()</CODE> <BR> Gets the <CODE>Assignment</CODE> objects of the <CODE>Model</CODE>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.List</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/data/source/Model.html#getAutoAssignments()">getAutoAssignments</A></B>()</CODE> <BR> Gets the <CODE>Assignment</CODE> objects that Oracle OLAP automatically creates for the <CODE>Model</CODE>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> int</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/data/source/Model.html#getDefaultPrecedence()">getDefaultPrecedence</A></B>()</CODE> <BR> Gets the default precedence value for the <CODE>Model</CODE>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.List</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/data/source/Model.html#getInputs()">getInputs</A></B>()</CODE> <BR> Gets the <CODE>Source</CODE> objects that are the inputs of the <CODE>Model</CODE>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.List</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/data/source/Model.html#getOutputs()">getOutputs</A></B>()</CODE> <BR> Gets the <CODE>Source</CODE> objects that are the outputs of the <CODE>Model</CODE>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.util.List</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/data/source/Model.html#getParentModels()">getParentModels</A></B>()</CODE> <BR> Gets the <CODE>Model</CODE> objects that are the parents of the <CODE>Model</CODE>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A></CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/data/source/Model.html#getType()">getType</A></B>()</CODE> <BR> Gets the <CODE>Source</CODE> for the <CODE>FundamentalMetadataObject</CODE> that represents the data type of the <CODE>Model</CODE>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/data/source/Model.html#setDefaultPrecedence(int)">setDefaultPrecedence</A></B>(int precedence)</CODE> <BR> Specifies the default precedence, which is the precedence value for <CODE>Assignment</CODE> objects that are created by methods that do not specify a precedence value.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> void</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/data/source/Model.html#unassign(oracle.olapi.data.source.Assignment)">unassign</A></B>(<A HREF="../../../../oracle/olapi/data/source/Assignment.html" title="class in oracle.olapi.data.source">Assignment</A> assignment)</CODE> <BR> Removes an <CODE>Assignment</CODE> from the <CODE>Model</CODE>.</TD> </TR> </TABLE> <P> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> <B>Method Detail</B></FONT></TH> </TR> </TABLE> <A NAME="getType()"><!-- --></A><H3> getType</H3> <PRE> <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A> <B>getType</B>()</PRE> <DL> <DD>Gets the <CODE>Source</CODE> for the <CODE>FundamentalMetadataObject</CODE> that represents the data type of the <CODE>Model</CODE>. <P> <DD><DL> <DT><B>Returns:</B><DD>The fundamental <CODE>Source</CODE> that is the type of the <CODE>Model</CODE>.</DL> </DD> </DL> <HR> <A NAME="getInputs()"><!-- --></A><H3> getInputs</H3> <PRE> java.util.List <B>getInputs</B>()</PRE> <DL> <DD>Gets the <CODE>Source</CODE> objects that are the inputs of the <CODE>Model</CODE>. <P> <DD><DL> <DT><B>Returns:</B><DD>A <CODE>List</CODE> of the <CODE>Source</CODE> objects that are the inputs of the <CODE>Model</CODE>.</DL> </DD> </DL> <HR> <A NAME="getOutputs()"><!-- --></A><H3> getOutputs</H3> <PRE> java.util.List <B>getOutputs</B>()</PRE> <DL> <DD>Gets the <CODE>Source</CODE> objects that are the outputs of the <CODE>Model</CODE>. A <CODE>CustomModel</CODE> can have outputs. An <CODE>MdmModel</CODE> does not have outputs. <P> <DD><DL> <DT><B>Returns:</B><DD>A <CODE>List</CODE> of the <CODE>Source</CODE> objects that are the outputs of the <CODE>Model</CODE>.</DL> </DD> </DL> <HR> <A NAME="getParentModels()"><!-- --></A><H3> getParentModels</H3> <PRE> java.util.List <B>getParentModels</B>()</PRE> <DL> <DD>Gets the <CODE>Model</CODE> objects that are the parents of the <CODE>Model</CODE>. A <CODE>Model</CODE> can inherit the <CODE>Assignment</CODE> objects of a parent if the type, the inputs, and any outputs of the <CODE>Model</CODE> are the same as those of the parent <CODE>Model</CODE>. <P> <DD><DL> <DT><B>Returns:</B><DD>A <CODE>List</CODE> of the <CODE>Model</CODE> objects that are the parent models of the <CODE>Model</CODE>.</DL> </DD> </DL> <HR> <A NAME="getAssignments()"><!-- --></A><H3> getAssignments</H3> <PRE> java.util.List <B>getAssignments</B>()</PRE> <DL> <DD>Gets the <CODE>Assignment</CODE> objects of the <CODE>Model</CODE>. <P> <DD><DL> <DT><B>Returns:</B><DD>A <CODE>List</CODE> of the <CODE>Assignment</CODE> objects of the <CODE>Model</CODE>.</DL> </DD> </DL> <HR> <A NAME="getAutoAssignments()"><!-- --></A><H3> getAutoAssignments</H3> <PRE> java.util.List <B>getAutoAssignments</B>()</PRE> <DL> <DD>Gets the <CODE>Assignment</CODE> objects that Oracle OLAP automatically creates for the <CODE>Model</CODE>. <P> <DD><DL> <DT><B>Returns:</B><DD>A <CODE>List</CODE> of the <CODE>Assignment</CODE> objects created automatically for the <CODE>Model</CODE>.<DT><B>See Also:</B><DD><A HREF="../../../../oracle/olapi/metadata/mdm/MdmDimensionCalculationModel.html" title="class in oracle.olapi.metadata.mdm"><CODE>MdmDimensionCalculationModel</CODE></A></DL> </DD> </DL> <HR> <A NAME="assign(oracle.olapi.data.source.Qualification[], oracle.olapi.data.source.Source)"><!-- --></A><H3> assign</H3> <PRE> void <B>assign</B>(<A HREF="../../../../oracle/olapi/data/source/Qualification.html" title="class in oracle.olapi.data.source">Qualification</A>[] qualifications, <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A> assigned)</PRE> <DL> <DD>Creates an <CODE>Assignment</CODE> with the default precedence and adds it to the <CODE>Model</CODE>. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>qualifications</CODE> - An array of <CODE>Qualification</CODE> objects, each of which specifies an element of an input <CODE>Source</CODE>. The array can include a <CODE>Qualification</CODE> for each input of the <CODE>Model</CODE>.<DD><CODE>assigned</CODE> - A <CODE>Source</CODE> that specifies the value to assign.</DL> </DD> </DL> <HR> <A NAME="assign(oracle.olapi.data.source.Qualification[], oracle.olapi.data.source.Source, int)"><!-- --></A><H3> assign</H3> <PRE> void <B>assign</B>(<A HREF="../../../../oracle/olapi/data/source/Qualification.html" title="class in oracle.olapi.data.source">Qualification</A>[] qualifications, <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A> assigned, int precedence)</PRE> <DL> <DD>Creates an <CODE>Assignment</CODE> with the specified precedence and adds it to the <CODE>Model</CODE>. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>qualifications</CODE> - An array of <CODE>Qualification</CODE> objects, each of which specifies an element of an input <CODE>Source</CODE>. The array can include a <CODE>Qualification</CODE> for each input of the <CODE>Model</CODE>.<DD><CODE>assigned</CODE> - A <CODE>Source</CODE> that specifies the value to assign.<DD><CODE>precedence</CODE> - An integer that specifies a precedence value for the <CODE>Assignment</CODE>.</DL> </DD> </DL> <HR> <A NAME="assign(java.lang.String, oracle.olapi.data.source.Source)"><!-- --></A><H3> assign</H3> <PRE> void <B>assign</B>(java.lang.String value, <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A> assigned)</PRE> <DL> <DD>Creates an <CODE>Assignment</CODE> with the default precedence and adds it to the <CODE>Model</CODE>; use this method for a <CODE>Model</CODE> that has only one input. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>value</CODE> - A <CODE>String</CODE> that specifies an element of the input <CODE>Source</CODE>.<DD><CODE>assigned</CODE> - A <CODE>Source</CODE> that specifies the value to assign.</DL> </DD> </DL> <HR> <A NAME="assign(java.lang.String, oracle.olapi.data.source.Source, int)"><!-- --></A><H3> assign</H3> <PRE> void <B>assign</B>(java.lang.String value, <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A> assigned, int precedence)</PRE> <DL> <DD>Creates an <CODE>Assignment</CODE> with the specified precedence and adds it to the <CODE>Model</CODE>; use this method for a <CODE>Model</CODE> that has only one input. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>value</CODE> - A <CODE>String</CODE> that specifies an element of the input <CODE>Source</CODE>.<DD><CODE>assigned</CODE> - A <CODE>Source</CODE> that specifies the value to assign.<DD><CODE>precedence</CODE> - An integer that specifies a precedence value for the <CODE>Assignment</CODE>.</DL> </DD> </DL> <HR> <A NAME="assign(java.lang.String[], oracle.olapi.data.source.Source)"><!-- --></A><H3> assign</H3> <PRE> void <B>assign</B>(java.lang.String[] values, <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A> assigned)</PRE> <DL> <DD>Creates an <CODE>Assignment</CODE> with the default precedence and adds it to the <CODE>Model</CODE>. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>values</CODE> - An array of <CODE>String</CODE> objects each of which specifies an element of an input <CODE>Source</CODE>. The array can include a element for each input of the <CODE>Model</CODE>.<DD><CODE>assigned</CODE> - A <CODE>Source</CODE> that specifies the value to assign.</DL> </DD> </DL> <HR> <A NAME="assign(java.lang.String[], oracle.olapi.data.source.Source, int)"><!-- --></A><H3> assign</H3> <PRE> void <B>assign</B>(java.lang.String[] values, <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A> assigned, int precedence)</PRE> <DL> <DD>Creates an <CODE>Assignment</CODE> with the specified precedence and adds it to the <CODE>Model</CODE>. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>values</CODE> - An array of <CODE>String</CODE> objects each of which specifies an element of an input <CODE>Source</CODE>. The array can include a element for each input of the <CODE>Model</CODE>.<DD><CODE>assigned</CODE> - A <CODE>Source</CODE> that specifies the value to assign.<DD><CODE>precedence</CODE> - An integer that specifies a precedence value for the <CODE>Assignment</CODE>.</DL> </DD> </DL> <HR> <A NAME="unassign(oracle.olapi.data.source.Assignment)"><!-- --></A><H3> unassign</H3> <PRE> void <B>unassign</B>(<A HREF="../../../../oracle/olapi/data/source/Assignment.html" title="class in oracle.olapi.data.source">Assignment</A> assignment)</PRE> <DL> <DD>Removes an <CODE>Assignment</CODE> from the <CODE>Model</CODE>. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>assignment</CODE> - The <CODE>Assignment</CODE> to remove.</DL> </DD> </DL> <HR> <A NAME="getDefaultPrecedence()"><!-- --></A><H3> getDefaultPrecedence</H3> <PRE> int <B>getDefaultPrecedence</B>()</PRE> <DL> <DD>Gets the default precedence value for the <CODE>Model</CODE>. <P> <DD><DL> <DT><B>Returns:</B><DD>An integer that represents the precedence for <CODE>Assignment</CODE> objects that are created by methods that do not specify a precedence value.</DL> </DD> </DL> <HR> <A NAME="setDefaultPrecedence(int)"><!-- --></A><H3> setDefaultPrecedence</H3> <PRE> void <B>setDefaultPrecedence</B>(int precedence)</PRE> <DL> <DD>Specifies the default precedence, which is the precedence value for <CODE>Assignment</CODE> objects that are created by methods that do not specify a precedence value. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>precedence</CODE> - An integer value to set as the default precedence.</DL> </DD> </DL> <HR> <A NAME="createSolvedSource()"><!-- --></A><H3> createSolvedSource</H3> <PRE> <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A> <B>createSolvedSource</B>()</PRE> <DL> <DD>Creates a <CODE>Source</CODE> that represents the results of the evaluation of the <CODE>Assignment</CODE> objects of the <CODE>Model</CODE>; elements of the returned <CODE>Source</CODE> that do not have an assigned value have a value of <CODE>null</CODE>. The <CODE>Source</CODE> has as inputs the <CODE>Source</CODE> objects that are the inputs of the <CODE>Model</CODE> associated with it. <P> <DD><DL> <DT><B>Returns:</B><DD>A <CODE>Source</CODE> that represents the results of the evaluation of the <CODE>Assignment</CODE> objects of the <CODE>Model</CODE> and that has <CODE>null</CODE> for unassigned values.</DL> </DD> </DL> <HR> <A NAME="createSolvedSource(oracle.olapi.data.source.Source)"><!-- --></A><H3> createSolvedSource</H3> <PRE> <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A> <B>createSolvedSource</B>(<A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A> defaultValues)</PRE> <DL> <DD>Creates a <CODE>Source</CODE> that represents the results of the evaluation of the <CODE>Assignment</CODE> objects of the <CODE>Model</CODE>; elements of the returned <CODE>Source</CODE> that do not have an assigned value have the value specified by the <CODE>defaultValues</CODE> <CODE>Source</CODE>. The <CODE>Source</CODE> has as inputs the <CODE>Source</CODE> objects that are the inputs of the <CODE>Model</CODE> associated with it. <P> <DD><DL> <DT><B>Parameters:</B><DD><CODE>defaultValues</CODE> - A <CODE>Source</CODE> that specifies the value to assign for a member of an input when the <CODE>Assignment</CODE> objects of the <CODE>Model</CODE> do not assign a value for the input member. <DT><B>Returns:</B><DD>A <CODE>Source</CODE> that represents the results of the evaluation of the <CODE>Assignment</CODE> objects of the <CODE>Model</CODE> and that has the value of <CODE>defaultValues</CODE> for unassigned values.</DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> <center>Copyright © 2002, 2009, Oracle. All rights reserved.</center></EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../oracle/olapi/data/source/LiteralQualification.html" title="class in oracle.olapi.data.source"><B>PREV CLASS</B></A> <A HREF="../../../../oracle/olapi/data/source/NumberParameter.html" title="class in oracle.olapi.data.source"><B>NEXT CLASS</B></A></FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html?oracle/olapi/data/source/Model.html" target="_top"><B>FRAMES</B></A> <A HREF="Model.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> </BODY> </HTML>
Ms-Dos/Windows
Unix
Write backup
jsp File Browser version 1.2 by
www.vonloesch.de