Edit D:\app\Administrator\product\11.2.0\dbhome_1\olap\api\doc\oracle\olapi\data\source\CustomModel.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> CustomModel (Oracle OLAP Java API Reference) </TITLE> <META NAME="keywords" CONTENT="oracle.olapi.data.source.CustomModel class"> <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> <SCRIPT type="text/javascript"> function windowTitle() { parent.document.title="CustomModel (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/CursorSpecificationVisitor.html" title="class in oracle.olapi.data.source"><B>PREV CLASS</B></A> <A HREF="../../../../oracle/olapi/data/source/DataProvider.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/CustomModel.html" target="_top"><B>FRAMES</B></A> <A HREF="CustomModel.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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> Class CustomModel</H2> <PRE> java.lang.Object <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>oracle.olapi.data.source.CustomModel</B> </PRE> <DL> <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../oracle/olapi/data/source/Model.html" title="interface in oracle.olapi.data.source">Model</A></DD> </DL> <HR> <DL> <DT><PRE>public final class <B>CustomModel</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../oracle/olapi/data/source/Model.html" title="interface in oracle.olapi.data.source">Model</A></DL> </PRE> <P> A <CODE>Model</CODE> that an application can explicitly create. To create a <CODE>CustomModel</CODE>, call one of the <CODE>createModel</CODE> methods of the <CODE>DataProvider</CODE> in use. <P> By calling a <CODE>createSolvedSource</CODE> method of a <CODE>CustomModel</CODE>, you can produce a <CODE>Source</CODE> that represents the evaluation of the <CODE>Assignment</CODE> objects of the <CODE>CustomModel</CODE>. The solved <CODE>Source</CODE> has all of the inputs of the <CODE>CustomModel</CODE>. <P> The <CODE>ImplementingExtractAsACustomModel.java</CODE> example program demonstrates creating a <CODE>CustomModel</CODE>. For information on the example programs, see <a href="../../../../doc-files/ExamplePrograms.html">Example Oracle OLAP Java API Programs</a>. <P> <P> <DL> <DT><B>See Also:</B><DD><A HREF="../../../../oracle/olapi/data/source/Assignment.html" title="class in oracle.olapi.data.source"><CODE>Assignment</CODE></A>, <A HREF="../../../../oracle/olapi/data/source/Qualification.html" title="class in oracle.olapi.data.source"><CODE>Qualification</CODE></A></DL> <HR> <P> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <A NAME="constructor_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>Constructor Summary</B></FONT></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><B><A HREF="../../../../oracle/olapi/data/source/CustomModel.html#CustomModel(oracle.olapi.data.source.DataProvider, oracle.olapi.data.source.Source[], oracle.olapi.data.source.Source, oracle.olapi.data.source.Source[], oracle.olapi.data.source.Model[], oracle.olapi.transaction.Transaction)">CustomModel</A></B>(<A HREF="../../../../oracle/olapi/data/source/DataProvider.html" title="class in oracle.olapi.data.source">DataProvider</A> dataProvider, <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A>[] inputs, <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A> type, <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A>[] outputs, <A HREF="../../../../oracle/olapi/data/source/Model.html" title="interface in oracle.olapi.data.source">Model</A>[] parentModels, <A HREF="../../../../oracle/olapi/transaction/Transaction.html" title="interface in oracle.olapi.transaction">Transaction</A> transaction)</CODE> <BR> Creates a new <CODE>CustomModel</CODE>.</TD> </TR> </TABLE> <!-- ========== 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/CustomModel.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>CustomModel</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/CustomModel.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>CustomModel</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/CustomModel.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>CustomModel</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/CustomModel.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>CustomModel</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/CustomModel.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>CustomModel</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/CustomModel.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>CustomModel</CODE>; use this method for a <CODE>CustomModel</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/CustomModel.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 <CODE>CustomModel</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/CustomModel.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>CustomModel</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/CustomModel.html#getAssignments()">getAssignments</A></B>()</CODE> <BR> Gets the <CODE>Assignment</CODE> objects of the <CODE>CustomModel</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/CustomModel.html#getAutoAssignments()">getAutoAssignments</A></B>()</CODE> <BR> Gets an empty <CODE>List</CODE> because Oracle OLAP does not automatically create <CODE>Assignment</CODE> objects for a <CODE>CustomModel</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/CustomModel.html#getDefaultPrecedence()">getDefaultPrecedence</A></B>()</CODE> <BR> Gets the default precedence value for the <CODE>CustomModel</CODE>.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> <CODE> java.lang.String</CODE></FONT></TD> <TD><CODE><B><A HREF="../../../../oracle/olapi/data/source/CustomModel.html#getID()">getID</A></B>()</CODE> <BR> Gets a <CODE>String</CODE> that uniquely identifies the <CODE>CustomModel</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/CustomModel.html#getInputs()">getInputs</A></B>()</CODE> <BR> Gets the <CODE>Source</CODE> objects that are the inputs of the <CODE>CustomModel</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/CustomModel.html#getOutputs()">getOutputs</A></B>()</CODE> <BR> Gets the <CODE>Source</CODE> objects that are the outputs of the <CODE>CustomModel</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/CustomModel.html#getParentModels()">getParentModels</A></B>()</CODE> <BR> Gets the <CODE>Model</CODE> objects from which the <CODE>CustomModel</CODE> inherits <CODE>Assignment</CODE> objects.</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/CustomModel.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>CustomModel</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/CustomModel.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 precendence 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/CustomModel.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>CustomModel</CODE>.</TD> </TR> </TABLE> <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> </TR> </TABLE> <P> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_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>Constructor Detail</B></FONT></TH> </TR> </TABLE> <A NAME="CustomModel(oracle.olapi.data.source.DataProvider, oracle.olapi.data.source.Source[], oracle.olapi.data.source.Source, oracle.olapi.data.source.Source[], oracle.olapi.data.source.Model[], oracle.olapi.transaction.Transaction)"><!-- --></A><H3> CustomModel</H3> <PRE> public <B>CustomModel</B>(<A HREF="../../../../oracle/olapi/data/source/DataProvider.html" title="class in oracle.olapi.data.source">DataProvider</A> dataProvider, <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A>[] inputs, <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A> type, <A HREF="../../../../oracle/olapi/data/source/Source.html" title="class in oracle.olapi.data.source">Source</A>[] outputs, <A HREF="../../../../oracle/olapi/data/source/Model.html" title="interface in oracle.olapi.data.source">Model</A>[] parentModels, <A HREF="../../../../oracle/olapi/transaction/Transaction.html" title="interface in oracle.olapi.transaction">Transaction</A> transaction)</PRE> <DL> <DD>Creates a new <CODE>CustomModel</CODE>. An application typically creates a <CODE>CustomModel</CODE> by calling one of the <CODE>createModel</CODE> methods of the <CODE>DataProvider</CODE> it is using. <P> <DL> <DT><B>Parameters:</B><DD><CODE>dataProvider</CODE> - The <CODE>DataProvider</CODE> that you are using.<DD><CODE>inputs</CODE> - An array of <CODE>Source</CODE> objects that are the inputs of the <CODE>CustomModel</CODE>. The <CODE>Qualification</CODE> objects of the <CODE>Assignment</CODE> objects of the <CODE>CustomModel</CODE> specify the values of the inputs for which the <CODE>CustomModel</CODE> assigns values.<DD><CODE>type</CODE> - The <CODE>Source</CODE> for the <CODE>FundamentalMetadataObject</CODE> for the data type that you want the <CODE>CustomModel</CODE> to have.<DD><CODE>outputs</CODE> - An array of <CODE>Source</CODE> objects that you want the <CODE>CustomModel</CODE> to have as outputs. An assigned <CODE>Source</CODE> of the <CODE>Assignment</CODE> objects of the <CODE>CustomModel</CODE> must have the same the outputs as the <CODE>CustomModel</CODE>.<DD><CODE>parentModels</CODE> - An array of <CODE>Model</CODE> objects from which the <CODE>CustomModel</CODE> inherits <CODE>Assignment</CODE> objects.<DD><CODE>transaction</CODE> - The current <CODE>Transaction</CODE>.</DL> </DL> <!-- ============ 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="getID()"><!-- --></A><H3> getID</H3> <PRE> public final java.lang.String <B>getID</B>()</PRE> <DL> <DD>Gets a <CODE>String</CODE> that uniquely identifies the <CODE>CustomModel</CODE>. <P> <DD><DL> </DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>A <CODE>String</CODE> that uniquely identifies the <CODE>CustomModel</CODE>.</DL> </DD> </DL> <HR> <A NAME="getType()"><!-- --></A><H3> getType</H3> <PRE> public final <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>CustomModel</CODE>. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../oracle/olapi/data/source/Model.html#getType()">getType</A></CODE> in interface <CODE><A HREF="../../../../oracle/olapi/data/source/Model.html" title="interface in oracle.olapi.data.source">Model</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>The fundamental <CODE>Source</CODE> that is the type of the <CODE>CustomModel</CODE>.</DL> </DD> </DL> <HR> <A NAME="getInputs()"><!-- --></A><H3> getInputs</H3> <PRE> public final java.util.List <B>getInputs</B>()</PRE> <DL> <DD>Gets the <CODE>Source</CODE> objects that are the inputs of the <CODE>CustomModel</CODE>. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../oracle/olapi/data/source/Model.html#getInputs()">getInputs</A></CODE> in interface <CODE><A HREF="../../../../oracle/olapi/data/source/Model.html" title="interface in oracle.olapi.data.source">Model</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>A <CODE>List</CODE> of the <CODE>Source</CODE> objects that are the inputs of the <CODE>CustomModel</CODE>.</DL> </DD> </DL> <HR> <A NAME="getOutputs()"><!-- --></A><H3> getOutputs</H3> <PRE> public final java.util.List <B>getOutputs</B>()</PRE> <DL> <DD>Gets the <CODE>Source</CODE> objects that are the outputs of the <CODE>CustomModel</CODE>. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../oracle/olapi/data/source/Model.html#getOutputs()">getOutputs</A></CODE> in interface <CODE><A HREF="../../../../oracle/olapi/data/source/Model.html" title="interface in oracle.olapi.data.source">Model</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>A <CODE>List</CODE> of the <CODE>Source</CODE> objects that are the outputs of the <CODE>CustomModel</CODE>.</DL> </DD> </DL> <HR> <A NAME="getParentModels()"><!-- --></A><H3> getParentModels</H3> <PRE> public final java.util.List <B>getParentModels</B>()</PRE> <DL> <DD>Gets the <CODE>Model</CODE> objects from which the <CODE>CustomModel</CODE> inherits <CODE>Assignment</CODE> objects. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../oracle/olapi/data/source/Model.html#getParentModels()">getParentModels</A></CODE> in interface <CODE><A HREF="../../../../oracle/olapi/data/source/Model.html" title="interface in oracle.olapi.data.source">Model</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>A <CODE>List</CODE> of the <CODE>Model</CODE> objects from which the <CODE>CustomModel</CODE> inherits <CODE>Assignment</CODE> objects.</DL> </DD> </DL> <HR> <A NAME="getAssignments()"><!-- --></A><H3> getAssignments</H3> <PRE> public java.util.List <B>getAssignments</B>()</PRE> <DL> <DD>Gets the <CODE>Assignment</CODE> objects of the <CODE>CustomModel</CODE>. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../oracle/olapi/data/source/Model.html#getAssignments()">getAssignments</A></CODE> in interface <CODE><A HREF="../../../../oracle/olapi/data/source/Model.html" title="interface in oracle.olapi.data.source">Model</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>A <CODE>List</CODE> of the <CODE>Assignment</CODE> objects of the <CODE>CustomModel</CODE>.</DL> </DD> </DL> <HR> <A NAME="getAutoAssignments()"><!-- --></A><H3> getAutoAssignments</H3> <PRE> public java.util.List <B>getAutoAssignments</B>()</PRE> <DL> <DD>Gets an empty <CODE>List</CODE> because Oracle OLAP does not automatically create <CODE>Assignment</CODE> objects for a <CODE>CustomModel</CODE>. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../oracle/olapi/data/source/Model.html#getAutoAssignments()">getAutoAssignments</A></CODE> in interface <CODE><A HREF="../../../../oracle/olapi/data/source/Model.html" title="interface in oracle.olapi.data.source">Model</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>An empty <CODE>List</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> public 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>CustomModel</CODE>. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../oracle/olapi/data/source/Model.html#assign(oracle.olapi.data.source.Qualification[], oracle.olapi.data.source.Source)">assign</A></CODE> in interface <CODE><A HREF="../../../../oracle/olapi/data/source/Model.html" title="interface in oracle.olapi.data.source">Model</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>qualifications</CODE> - An array of <CODE>Qualification</CODE> objects, each of which specifies a <CODE>Source</CODE> and an element of that <CODE>Source</CODE>. The array must have a <CODE>Qualification</CODE> for each input of the <CODE>CustomModel</CODE>.<DD><CODE>assigned</CODE> - A <CODE>Source</CODE> that is the assigned <CODE>Source</CODE> for the <CODE>Assignment</CODE>.</DL> </DD> </DL> <HR> <A NAME="assign(oracle.olapi.data.source.Qualification[], oracle.olapi.data.source.Source, int)"><!-- --></A><H3> assign</H3> <PRE> public 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>CustomModel</CODE>. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../oracle/olapi/data/source/Model.html#assign(oracle.olapi.data.source.Qualification[], oracle.olapi.data.source.Source, int)">assign</A></CODE> in interface <CODE><A HREF="../../../../oracle/olapi/data/source/Model.html" title="interface in oracle.olapi.data.source">Model</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>qualifications</CODE> - An array of <CODE>Qualification</CODE> objects, each of which specifies a <CODE>Source</CODE> and an element of that <CODE>Source</CODE>. The array must have a <CODE>Qualification</CODE> for each input of the <CODE>CustomModel</CODE>.<DD><CODE>assigned</CODE> - A <CODE>Source</CODE> that is the assigned <CODE>Source</CODE> for the <CODE>Assignment</CODE>.<DD><CODE>precedence</CODE> - An integer that specifies the 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> public 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>CustomModel</CODE> that has only one input. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../oracle/olapi/data/source/Model.html#assign(java.lang.String, oracle.olapi.data.source.Source)">assign</A></CODE> in interface <CODE><A HREF="../../../../oracle/olapi/data/source/Model.html" title="interface in oracle.olapi.data.source">Model</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>value</CODE> - A <CODE>String</CODE> that contains the value of an element of the qualified <CODE>Source</CODE> for the <CODE>Qualification</CODE> of the <CODE>Assignment</CODE>.<DD><CODE>assigned</CODE> - A <CODE>Source</CODE> that is the assigned <CODE>Source</CODE> for the <CODE>Assignment</CODE>.</DL> </DD> </DL> <HR> <A NAME="assign(java.lang.String, oracle.olapi.data.source.Source, int)"><!-- --></A><H3> assign</H3> <PRE> public 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>CustomModel</CODE>; use this method for a <CODE>CustomModel</CODE> that has only one input. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../oracle/olapi/data/source/Model.html#assign(java.lang.String, oracle.olapi.data.source.Source, int)">assign</A></CODE> in interface <CODE><A HREF="../../../../oracle/olapi/data/source/Model.html" title="interface in oracle.olapi.data.source">Model</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>value</CODE> - A <CODE>String</CODE> that contains the value of an element of the qualified <CODE>Source</CODE> for the <CODE>Qualification</CODE> of the <CODE>Assignment</CODE>.<DD><CODE>assigned</CODE> - A <CODE>Source</CODE> that is the assigned <CODE>Source</CODE> of the <CODE>Assignment</CODE>.<DD><CODE>precedence</CODE> - An integer that specifies the 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> public 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>CustomModel</CODE>. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../oracle/olapi/data/source/Model.html#assign(java.lang.String[], oracle.olapi.data.source.Source)">assign</A></CODE> in interface <CODE><A HREF="../../../../oracle/olapi/data/source/Model.html" title="interface in oracle.olapi.data.source">Model</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>values</CODE> - An array of <CODE>String</CODE> objects, each of which contains the value of an element of a qualified <CODE>Source</CODE> for the <CODE>Qualification</CODE> objects of the <CODE>Assignment</CODE>. The array must have a <CODE>String</CODE> value for each input of the <CODE>CustomModel</CODE>.<DD><CODE>assigned</CODE> - A <CODE>Source</CODE> that is the assigned <CODE>Source</CODE> for the <CODE>Assignment</CODE>.</DL> </DD> </DL> <HR> <A NAME="assign(java.lang.String[], oracle.olapi.data.source.Source, int)"><!-- --></A><H3> assign</H3> <PRE> public 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>CustomModel</CODE>. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../oracle/olapi/data/source/Model.html#assign(java.lang.String[], oracle.olapi.data.source.Source, int)">assign</A></CODE> in interface <CODE><A HREF="../../../../oracle/olapi/data/source/Model.html" title="interface in oracle.olapi.data.source">Model</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>values</CODE> - An array of <CODE>String</CODE> objects, each of which contains the value of an element of a qualified <CODE>Source</CODE> for the <CODE>Qualification</CODE> objects of the <CODE>Assignment</CODE>. The array must have a <CODE>String</CODE> value for each input of the <CODE>CustomModel</CODE>.<DD><CODE>assigned</CODE> - A <CODE>Source</CODE> that is the assigned <CODE>Source</CODE> for the <CODE>Assignment</CODE>.<DD><CODE>precedence</CODE> - An integer that specifies the precedence value for the <CODE>Assignment</CODE>.</DL> </DD> </DL> <HR> <A NAME="unassign(oracle.olapi.data.source.Assignment)"><!-- --></A><H3> unassign</H3> <PRE> public 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>CustomModel</CODE>. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../oracle/olapi/data/source/Model.html#unassign(oracle.olapi.data.source.Assignment)">unassign</A></CODE> in interface <CODE><A HREF="../../../../oracle/olapi/data/source/Model.html" title="interface in oracle.olapi.data.source">Model</A></CODE></DL> </DD> <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> public int <B>getDefaultPrecedence</B>()</PRE> <DL> <DD>Gets the default precedence value for the <CODE>CustomModel</CODE>. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../oracle/olapi/data/source/Model.html#getDefaultPrecedence()">getDefaultPrecedence</A></CODE> in interface <CODE><A HREF="../../../../oracle/olapi/data/source/Model.html" title="interface in oracle.olapi.data.source">Model</A></CODE></DL> </DD> <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> public 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 precendence value. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../oracle/olapi/data/source/Model.html#setDefaultPrecedence(int)">setDefaultPrecedence</A></CODE> in interface <CODE><A HREF="../../../../oracle/olapi/data/source/Model.html" title="interface in oracle.olapi.data.source">Model</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>precedence</CODE> - An integer value to set as the default precedence; a higher value indicates a higher precedence.</DL> </DD> </DL> <HR> <A NAME="createSolvedSource()"><!-- --></A><H3> createSolvedSource</H3> <PRE> public final <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 <CODE>CustomModel</CODE>. For an element of the returned <CODE>Source</CODE> that does not have an assigned value, the value is <CODE>null</CODE>. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../oracle/olapi/data/source/Model.html#createSolvedSource()">createSolvedSource</A></CODE> in interface <CODE><A HREF="../../../../oracle/olapi/data/source/Model.html" title="interface in oracle.olapi.data.source">Model</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>A <CODE>Source</CODE> represents the results of the evaluation of the <CODE>Assignment</CODE> objects of <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> public final <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>CustomModel</CODE>. The 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>. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../oracle/olapi/data/source/Model.html#createSolvedSource(oracle.olapi.data.source.Source)">createSolvedSource</A></CODE> in interface <CODE><A HREF="../../../../oracle/olapi/data/source/Model.html" title="interface in oracle.olapi.data.source">Model</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>defaultValues</CODE> - A <CODE>Source</CODE> that specifies the value that you want Oracle OLAP to assign for a member of an input when the <CODE>Assignment</CODE> objects of the <CODE>CustomModel</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>CustomModel</CODE> and that has the values 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/CursorSpecificationVisitor.html" title="class in oracle.olapi.data.source"><B>PREV CLASS</B></A> <A HREF="../../../../oracle/olapi/data/source/DataProvider.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/CustomModel.html" target="_top"><B>FRAMES</B></A> <A HREF="CustomModel.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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