Edit D:\app\Administrator\product\11.2.0\dbhome_1\olap\api\doc\oracle\olapi\syntax\SyntaxObject.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<HTML>
<HEAD>

<TITLE>
SyntaxObject (Oracle OLAP Java API Reference)
</TITLE>

<SCRIPT type="text/javascript">
function windowTitle()
{
 parent.document.title="SyntaxObject (Oracle OLAP Java API Reference)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<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">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>
Oracle&reg; OLAP Java API Reference 11g Release 2 (11.2) E10794-01 Beta Draft
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2">
&nbsp;<A HREF="../../../oracle/olapi/syntax/SyntaxException.html" title="class in oracle.olapi.syntax">PREV CLASS</A>&nbsp;
&nbsp;<A HREF="../../../oracle/olapi/syntax/SyntaxObjectVisitor.html" title="class in oracle.olapi.syntax">NEXT CLASS</A></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
 <A HREF="../../../index.html?oracle/olapi/syntax/SyntaxObject.html" target="_top">FRAMES</A> &nbsp;
&nbsp;<A HREF="SyntaxObject.html" target="_top">NO FRAMES</A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
 
</SCRIPT>
<NOSCRIPT>
 <A HREF="../../../allclasses-noframe.html">All Classes</A>
</NOSCRIPT>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>

<HR>

<H2>

oracle.olapi.syntax
 
Class SyntaxObject</H2>
<PRE>
java.lang.Object
 <IMG SRC="../../../resources/inherit.gif" ALT="extended by ">oracle.olapi.syntax.SyntaxObject
</PRE>
<DL>
<DT>Direct Known Subclasses: <DD><A HREF="../../../oracle/olapi/syntax/AggregateOverClause.html" title="class in oracle.olapi.syntax">AggregateOverClause</A>, <A HREF="../../../oracle/olapi/syntax/AggregationCase.html" title="class in oracle.olapi.syntax">AggregationCase</A>, <A HREF="../../../oracle/olapi/syntax/BuildCommand.html" title="class in oracle.olapi.syntax">BuildCommand</A>, <A HREF="../../../oracle/olapi/syntax/BuildItem.html" title="class in oracle.olapi.syntax">BuildItem</A>, <A HREF="../../../oracle/olapi/syntax/BuildProcess.html" title="class in oracle.olapi.syntax">BuildProcess</A>, <A HREF="../../../oracle/olapi/syntax/BuildSpecification.html" title="class in oracle.olapi.syntax">BuildSpecification</A>, <A HREF="../../../oracle/olapi/syntax/ConsistentSolveSpecification.html" title="class in oracle.olapi.syntax">ConsistentSolveSpecification</A>, <A HREF="../../../oracle/olapi/syntax/DataObject.html" title="class in oracle.olapi.syntax">DataObject</A>, <A HREF="../../../oracle/olapi/syntax/SQLDataType.html" title="class in oracle.olapi.syntax">SQLDataType</A>, <A HREF="../../../oracle/olapi/syntax/SymmetricCondition.html" title="class in oracle.olapi.syntax">SymmetricCondition</A>, <A HREF="../../../oracle/olapi/syntax/SymmetricConditionElement.html" title="class in oracle.olapi.syntax">SymmetricConditionElement</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public abstract class SyntaxObject<DT>extends java.lang.Object</DL>
</PRE>

An abstract base class for objects that specify tables or columns
 in an Oracle Database instance, and that represent selections of
 data and operations on the data.
 A <CODE>SyntaxObject</CODE> has static methods that construct a
 <CODE>SyntaxObject</CODE> from text in the expression syntax of the
 Oracle OLAP Java API.
 The expression syntax of the API is very similar to the SQL expression
 syntax.
 A <CODE>SyntaxObject</CODE> also has methods that convert the
 <CODE>SyntaxObject</CODE> into a textual representation in the
 expression syntax.

An application can create a <CODE>SyntaxObject</CODE> by using a
 <CODE>fromSyntax</CODE> method.
 It can also explicity create some subclasses of <CODE>SyntaxObject</CODE>
 by using a constructor method of the subclass or implicitly create other
 subclasses by using a method that returns a <CODE>SyntaxObject</CODE>.
 For example, the following code creates a <CODE>StringExpression</CODE>
 using a <CODE>fromSyntax</CODE> method, another
 <CODE>StringExpression</CODE> using a constructor method, and a
 <CODE>Query</CODE> using a method that returns a <CODE>Query</CODE>.

<pre>
 // mp is the MdmMetadataProvider for the session.
 // The expression syntax requires that a string literal be enclosed
 // in single quotation marks.
 StringExpression exp = (StringExpression)
 SyntaxObject.fromSyntax("'Hello world from syntax.'", mp);
 StringExpression strExp =
 new StringExpression("Hello world using constructor.");
 System.out.println(exp.getValue());
 System.out.println(strExp.getValue());

// prodTable is the MdmTable for the Products dimension.
 Query query = prodTable.getQuery(); </pre>

The output of the example is the following.

<pre>
 Hello world from syntax.
 Hello world using constructor.</pre>

<HR>

<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">
Method Summary</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/syntax/SyntaxObject.html#equals(oracle.olapi.syntax.SyntaxObject)">equals</A>(<A HREF="../../../oracle/olapi/syntax/SyntaxObject.html" title="class in oracle.olapi.syntax">SyntaxObject</A>&nbsp;synObject)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Performs a case-sensitive comparison between the string representation of 
 the specified <CODE>SyntaxObject</CODE> and that of this 
 <CODE>SyntaxObject</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/syntax/SyntaxObject.html#equals(oracle.olapi.syntax.SyntaxObject, boolean)">equals</A>(<A HREF="../../../oracle/olapi/syntax/SyntaxObject.html" title="class in oracle.olapi.syntax">SyntaxObject</A>&nbsp;synObject,
 boolean&nbsp;bIgnorecase)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Compares the string representation of the specified 
 <CODE>SyntaxObject</CODE> with that of this <CODE>SyntaxObject</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>static&nbsp;<A HREF="../../../oracle/olapi/syntax/SyntaxObject.html" title="class in oracle.olapi.syntax">SyntaxObject</A></CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/syntax/SyntaxObject.html#fromSyntax(java.lang.String, oracle.olapi.metadata.mdm.MdmMetadataProvider)">fromSyntax</A>(java.lang.String&nbsp;syntax,
 <A HREF="../../../oracle/olapi/metadata/mdm/MdmMetadataProvider.html" title="class in oracle.olapi.metadata.mdm">MdmMetadataProvider</A>&nbsp;metadataProvider)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a <CODE>SyntaxObject</CODE> from a string in expression
 syntax.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>static&nbsp;<A HREF="../../../oracle/olapi/syntax/SyntaxObject.html" title="class in oracle.olapi.syntax">SyntaxObject</A></CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/syntax/SyntaxObject.html#fromSyntax(java.lang.String, oracle.olapi.metadata.mdm.MdmMetadataProvider, java.lang.String)">fromSyntax</A>(java.lang.String&nbsp;syntax,
 <A HREF="../../../oracle/olapi/metadata/mdm/MdmMetadataProvider.html" title="class in oracle.olapi.metadata.mdm">MdmMetadataProvider</A>&nbsp;metadataProvider,
 java.lang.String&nbsp;owner)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a <CODE>SyntaxObject</CODE> from a string in expression
 syntax and provides an owner for the <CODE>SyntaxObject</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>static&nbsp;<A HREF="../../../oracle/olapi/syntax/SyntaxObject.html" title="class in oracle.olapi.syntax">SyntaxObject</A></CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/syntax/SyntaxObject.html#fromSyntax(java.lang.String, oracle.olapi.metadata.mdm.MdmMetadataProvider, java.lang.String, boolean)">fromSyntax</A>(java.lang.String&nbsp;syntax,
 <A HREF="../../../oracle/olapi/metadata/mdm/MdmMetadataProvider.html" title="class in oracle.olapi.metadata.mdm">MdmMetadataProvider</A>&nbsp;metadataProvider,
 java.lang.String&nbsp;owner,
 boolean&nbsp;isForQuery)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a <CODE>SyntaxObject</CODE> from a string in expression
 syntax, provides an owner for the <CODE>SyntaxObject</CODE>, and
 indicates whether the <CODE>SyntaxObject</CODE> is a <CODE>Query</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>static&nbsp;<A HREF="../../../oracle/olapi/syntax/SyntaxObject.html" title="class in oracle.olapi.syntax">SyntaxObject</A></CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/syntax/SyntaxObject.html#fromSyntax(java.lang.String, oracle.olapi.metadata.mdm.MdmMetadataProvider, java.lang.String, boolean, java.util.List)">fromSyntax</A>(java.lang.String&nbsp;syntax,
 <A HREF="../../../oracle/olapi/metadata/mdm/MdmMetadataProvider.html" title="class in oracle.olapi.metadata.mdm">MdmMetadataProvider</A>&nbsp;metadataProvider,
 java.lang.String&nbsp;owner,
 boolean&nbsp;isForQuery,
 java.util.List&lt;<A HREF="../../../oracle/olapi/syntax/Query.html" title="class in oracle.olapi.syntax">Query</A>&gt;&nbsp;queries)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a <CODE>SyntaxObject</CODE> from a string in expression
 syntax, provides an owner for the <CODE>SyntaxObject</CODE>,
 indicates whether the <CODE>SyntaxObject</CODE> is a <CODE>Query</CODE>,
 and provides the <CODE>Query</CODE> objects that are referenced by
 the expression.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>static&nbsp;<A HREF="../../../oracle/olapi/syntax/SyntaxObject.html" title="class in oracle.olapi.syntax">SyntaxObject</A></CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/syntax/SyntaxObject.html#fromSyntax(java.lang.String, oracle.olapi.metadata.mdm.MdmMetadataProvider, java.lang.String, boolean, java.util.List, oracle.olapi.metadata.XMLParserCallback)">fromSyntax</A>(java.lang.String&nbsp;syntax,
 <A HREF="../../../oracle/olapi/metadata/mdm/MdmMetadataProvider.html" title="class in oracle.olapi.metadata.mdm">MdmMetadataProvider</A>&nbsp;metadataProvider,
 java.lang.String&nbsp;owner,
 boolean&nbsp;isForQuery,
 java.util.List&lt;<A HREF="../../../oracle/olapi/syntax/Query.html" title="class in oracle.olapi.syntax">Query</A>&gt;&nbsp;queries,
 <A HREF="../../../oracle/olapi/metadata/XMLParserCallback.html" title="interface in oracle.olapi.metadata">XMLParserCallback</A>&nbsp;errorCallback)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a <CODE>SyntaxObject</CODE> from a string in expression
 syntax supplied by a <CODE>Reader</CODE>, provides an owner for the 
 <CODE>SyntaxObject</CODE>, indicates whether the 
 <CODE>SyntaxObject</CODE> is a <CODE>Query</CODE>, provides the 
 <CODE>Query</CODE> objects that are referenced by the expression, and
 provides an <CODE>XMLParserCallback</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/syntax/SyntaxObject.html#isValid()">isValid</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates whether the <CODE>SyntaxObject</CODE> has any 
 <CODE>UnresolvedExpression</CODE> objects associated with it.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;java.lang.String</CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/syntax/SyntaxObject.html#toSyntax()">toSyntax</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts the <CODE>SyntaxObject</CODE> into a textual representation
 in the expression syntax.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;java.lang.String</CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/syntax/SyntaxObject.html#toSyntax(java.lang.String)">toSyntax</A>(java.lang.String&nbsp;owner)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts the <CODE>SyntaxObject</CODE> into a textual representation
 in the expression syntax and provides the owner of the 
 <CODE>SyntaxObject</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;void</CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/syntax/SyntaxObject.html#toSyntax(java.lang.StringBuffer, java.lang.String, java.util.List)">toSyntax</A>(java.lang.StringBuffer&nbsp;buffer,
 java.lang.String&nbsp;owner,
 java.util.List&lt;<A HREF="../../../oracle/olapi/syntax/Query.html" title="class in oracle.olapi.syntax">Query</A>&gt;&nbsp;queries)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts the <CODE>SyntaxObject</CODE> into a textual representation
 in the expression syntax, provides the owner of the 
 <CODE>SyntaxObject</CODE> separately, and provides the <CODE>Query</CODE> 
 objects that are referenced in the <CODE>SyntaxObject</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;void</CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/syntax/SyntaxObject.html#toSyntax(java.lang.StringBuffer, java.lang.String, java.util.List, boolean)">toSyntax</A>(java.lang.StringBuffer&nbsp;buffer,
 java.lang.String&nbsp;owner,
 java.util.List&lt;<A HREF="../../../oracle/olapi/syntax/Query.html" title="class in oracle.olapi.syntax">Query</A>&gt;&nbsp;queries,
 boolean&nbsp;suppressNamespace)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts the <CODE>SyntaxObject</CODE> into a textual representation
 in the expression syntax, provides the owner of the 
 <CODE>SyntaxObject</CODE> separately, and provides the <CODE>Query</CODE> 
 objects that are referenced in the <CODE>SyntaxObject</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;java.lang.String</CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/syntax/SyntaxObject.html#toSyntax(java.lang.String, java.util.List)">toSyntax</A>(java.lang.String&nbsp;owner,
 java.util.List&lt;<A HREF="../../../oracle/olapi/syntax/Query.html" title="class in oracle.olapi.syntax">Query</A>&gt;&nbsp;queries)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts the <CODE>SyntaxObject</CODE> into a textual representation
 in the expression syntax, provides the owner of the 
 <CODE>SyntaxObject</CODE> separately, and provides the <CODE>Query</CODE> 
 objects that are referenced in the <CODE>SyntaxObject</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;java.lang.String</CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/syntax/SyntaxObject.html#toSyntax(java.lang.String, oracle.olapi.syntax.Query)">toSyntax</A>(java.lang.String&nbsp;owner,
 <A HREF="../../../oracle/olapi/syntax/Query.html" title="class in oracle.olapi.syntax">Query</A>&nbsp;query)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Converts the <CODE>SyntaxObject</CODE> into a textual representation
 in the expression syntax, provides the owner of the 
 <CODE>SyntaxObject</CODE> separately, and provides the <CODE>Query</CODE> 
 that is referenced in the <CODE>SyntaxObject</CODE>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>abstract &nbsp;java.lang.Object</CODE></TD>
<TD><CODE><A HREF="../../../oracle/olapi/syntax/SyntaxObject.html#visit(oracle.olapi.syntax.SyntaxObjectVisitor, java.lang.Object)">visit</A>(<A HREF="../../../oracle/olapi/syntax/SyntaxObjectVisitor.html" title="class in oracle.olapi.syntax">SyntaxObjectVisitor</A>&nbsp;visitor,
 java.lang.Object&nbsp;context)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Calls the appropriate method of a
 <code>SyntaxObjectVisitor</code> and passes that method the
 <code>SyntaxObject</code> and an <code>Object</code>.</TD>
</TR>
</TABLE>
&nbsp;<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">Methods inherited from class java.lang.Object</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;

<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">
Method Detail</TH>
</TR>
</TABLE>

<A NAME="visit(oracle.olapi.syntax.SyntaxObjectVisitor, java.lang.Object)"></A><H3>
visit</H3>
<PRE>
public abstract java.lang.Object visit(<A HREF="../../../oracle/olapi/syntax/SyntaxObjectVisitor.html" title="class in oracle.olapi.syntax">SyntaxObjectVisitor</A>&nbsp;visitor,
 java.lang.Object&nbsp;context)</PRE>
<DL>
<DD>Calls the appropriate method of a
 <code>SyntaxObjectVisitor</code> and passes that method the
 <code>SyntaxObject</code> and an <code>Object</code>.

<DD><DL>
<DT>Parameters:<DD><CODE>visitor</CODE> - A <code>SyntaxObjectVisitor</code>.<DD><CODE>context</CODE> - An <code>Object</code>.
<DT>Returns:<DD>The <code>Object</code> returned by the
 <code>visitClearCommand</code> method.</DL>
</DD>
</DL>
<HR>

<A NAME="toSyntax()"></A><H3>
toSyntax</H3>
<PRE>
public final java.lang.String toSyntax()</PRE>
<DL>
<DD>Converts the <CODE>SyntaxObject</CODE> into a textual representation
 in the expression syntax.

<DD><DL>

<DT>Returns:<DD>A <CODE>String</CODE> that contains the expression for the
 <CODE>SyntaxObject</CODE>.</DL>
</DD>
</DL>
<HR>

<A NAME="toSyntax(java.lang.String)"></A><H3>
toSyntax</H3>
<PRE>
public final java.lang.String toSyntax(java.lang.String&nbsp;owner)</PRE>
<DL>
<DD>Converts the <CODE>SyntaxObject</CODE> into a textual representation
 in the expression syntax and provides the owner of the 
 <CODE>SyntaxObject</CODE>.

<DD><DL>
<DT>Parameters:<DD><CODE>owner</CODE> - A <CODE>String</CODE> that is the name of the 
 <CODE>MdmDatabaseSchema</CODE> that owns the 
 <CODE>SyntaxObject</CODE>.
<DT>Returns:<DD>A <CODE>String</CODE> that contains the expression for the
 <CODE>SyntaxObject</CODE>.</DL>
</DD>
</DL>
<HR>

<A NAME="toSyntax(java.lang.String, oracle.olapi.syntax.Query)"></A><H3>
toSyntax</H3>
<PRE>
public final java.lang.String toSyntax(java.lang.String&nbsp;owner,
 <A HREF="../../../oracle/olapi/syntax/Query.html" title="class in oracle.olapi.syntax">Query</A>&nbsp;query)</PRE>
<DL>
<DD>Converts the <CODE>SyntaxObject</CODE> into a textual representation
 in the expression syntax, provides the owner of the 
 <CODE>SyntaxObject</CODE> separately, and provides the <CODE>Query</CODE> 
 that is referenced in the <CODE>SyntaxObject</CODE>.

<DD><DL>
<DT>Parameters:<DD><CODE>owner</CODE> - A <CODE>String</CODE> that is the name of the 
 <CODE>MdmDatabaseSchema</CODE> that owns the 
 <CODE>SyntaxObject</CODE>.<DD><CODE>query</CODE> - The <CODE>Query</CODE> that is referenced in the
 <CODE>SyntaxObject</CODE>.
<DT>Returns:<DD>A <CODE>String</CODE> that contains the expression for
 the <CODE>SyntaxObject</CODE>.</DL>
</DD>
</DL>
<HR>

<A NAME="toSyntax(java.lang.String, java.util.List)"></A><H3>
toSyntax</H3>
<PRE>
public final java.lang.String toSyntax(java.lang.String&nbsp;owner,
 java.util.List&lt;<A HREF="../../../oracle/olapi/syntax/Query.html" title="class in oracle.olapi.syntax">Query</A>&gt;&nbsp;queries)</PRE>
<DL>
<DD>Converts the <CODE>SyntaxObject</CODE> into a textual representation
 in the expression syntax, provides the owner of the 
 <CODE>SyntaxObject</CODE> separately, and provides the <CODE>Query</CODE> 
 objects that are referenced in the <CODE>SyntaxObject</CODE>.

<DD><DL>
<DT>Parameters:<DD><CODE>owner</CODE> - A <CODE>String</CODE> that is the name of the 
 <CODE>MdmDatabaseSchema</CODE> that owns the 
 <CODE>SyntaxObject</CODE>.<DD><CODE>queries</CODE> - A <CODE>List</CODE> of <CODE>Query</CODE> objects
 referenced in the <CODE>SyntaxObject</CODE>.
<DT>Returns:<DD>A <CODE>String</CODE> that contains the expression for
 the <CODE>SyntaxObject</CODE>.</DL>
</DD>
</DL>
<HR>

<A NAME="toSyntax(java.lang.StringBuffer, java.lang.String, java.util.List)"></A><H3>
toSyntax</H3>
<PRE>
public final void toSyntax(java.lang.StringBuffer&nbsp;buffer,
 java.lang.String&nbsp;owner,
 java.util.List&lt;<A HREF="../../../oracle/olapi/syntax/Query.html" title="class in oracle.olapi.syntax">Query</A>&gt;&nbsp;queries)</PRE>
<DL>
<DD>Converts the <CODE>SyntaxObject</CODE> into a textual representation
 in the expression syntax, provides the owner of the 
 <CODE>SyntaxObject</CODE> separately, and provides the <CODE>Query</CODE> 
 objects that are referenced in the <CODE>SyntaxObject</CODE>.

<DD><DL>
<DT>Parameters:<DD><CODE>buffer</CODE> - A <CODE>StringBuffer</CODE> that this method uses in
 parsing the expression.<DD><CODE>owner</CODE> - A <CODE>String</CODE> that is the name of the 
 <CODE>MdmDatabaseSchema</CODE> that owns the 
 <CODE>SyntaxObject</CODE>.<DD><CODE>queries</CODE> - A <CODE>List</CODE> of <CODE>Query</CODE> objects
 referenced in the <CODE>SyntaxObject</CODE>.</DL>
</DD>
</DL>
<HR>

<A NAME="toSyntax(java.lang.StringBuffer, java.lang.String, java.util.List, boolean)"></A><H3>
toSyntax</H3>
<PRE>
public final void toSyntax(java.lang.StringBuffer&nbsp;buffer,
 java.lang.String&nbsp;owner,
 java.util.List&lt;<A HREF="../../../oracle/olapi/syntax/Query.html" title="class in oracle.olapi.syntax">Query</A>&gt;&nbsp;queries,
 boolean&nbsp;suppressNamespace)</PRE>
<DL>
<DD>Converts the <CODE>SyntaxObject</CODE> into a textual representation
 in the expression syntax, provides the owner of the 
 <CODE>SyntaxObject</CODE> separately, and provides the <CODE>Query</CODE> 
 objects that are referenced in the <CODE>SyntaxObject</CODE>.

<DD><DL>
<DT>Parameters:<DD><CODE>buffer</CODE> - A <CODE>StringBuffer</CODE> that this method uses in
 parsing the expression.<DD><CODE>owner</CODE> - A <CODE>String</CODE> that is the name of the 
 <CODE>MdmDatabaseSchema</CODE> that owns the 
 <CODE>SyntaxObject</CODE>.<DD><CODE>queries</CODE> - A <CODE>List</CODE> of <CODE>Query</CODE> objects
 referenced in the <CODE>SyntaxObject</CODE>.<DD><CODE>suppressNamespace</CODE> - If <CODE>true</CODE>, namespaces are not printed
 for objects referenced in the <CODE>SyntaxObject</CODE>.
 If <CODE>false</CODE> (the default), namespaces
 are printed for all objects that are not in the
 default namespace.</DL>
</DD>
</DL>
<HR>

<A NAME="fromSyntax(java.lang.String, oracle.olapi.metadata.mdm.MdmMetadataProvider)"></A><H3>
fromSyntax</H3>
<PRE>
public static <A HREF="../../../oracle/olapi/syntax/SyntaxObject.html" title="class in oracle.olapi.syntax">SyntaxObject</A> fromSyntax(java.lang.String&nbsp;syntax,
 <A HREF="../../../oracle/olapi/metadata/mdm/MdmMetadataProvider.html" title="class in oracle.olapi.metadata.mdm">MdmMetadataProvider</A>&nbsp;metadataProvider)</PRE>
<DL>
<DD>Creates a <CODE>SyntaxObject</CODE> from a string in expression
 syntax.

<DD><DL>
<DT>Parameters:<DD><CODE>syntax</CODE> - A <CODE>String</CODE> that contains the expression
 that specifies a <CODE>SyntaxObject</CODE>.<DD><CODE>metadataProvider</CODE> - The <CODE>MdmMetadataProvider</CODE> for the
 current session.
<DT>Returns:<DD>A <CODE>SyntaxObject</CODE>.</DL>
</DD>
</DL>
<HR>

<A NAME="fromSyntax(java.lang.String, oracle.olapi.metadata.mdm.MdmMetadataProvider, java.lang.String)"></A><H3>
fromSyntax</H3>
<PRE>
public static <A HREF="../../../oracle/olapi/syntax/SyntaxObject.html" title="class in oracle.olapi.syntax">SyntaxObject</A> fromSyntax(java.lang.String&nbsp;syntax,
 <A HREF="../../../oracle/olapi/metadata/mdm/MdmMetadataProvider.html" title="class in oracle.olapi.metadata.mdm">MdmMetadataProvider</A>&nbsp;metadataProvider,
 java.lang.String&nbsp;owner)</PRE>
<DL>
<DD>Creates a <CODE>SyntaxObject</CODE> from a string in expression
 syntax and provides an owner for the <CODE>SyntaxObject</CODE>.

<DD><DL>
<DT>Parameters:<DD><CODE>syntax</CODE> - A <CODE>String</CODE> that contains the expression
 that specifies a <CODE>SyntaxObject</CODE>.<DD><CODE>metadataProvider</CODE> - The <CODE>MdmMetadataProvider</CODE> for the
 current session.<DD><CODE>owner</CODE> - A <CODE>String</CODE> that is the name of the 
 <CODE>MdmDatabaseSchema</CODE> to own the 
 <CODE>SyntaxObject</CODE>.
<DT>Returns:<DD>A <CODE>SyntaxObject</CODE>.</DL>
</DD>
</DL>
<HR>

<A NAME="fromSyntax(java.lang.String, oracle.olapi.metadata.mdm.MdmMetadataProvider, java.lang.String, boolean)"></A><H3>
fromSyntax</H3>
<PRE>
public static <A HREF="../../../oracle/olapi/syntax/SyntaxObject.html" title="class in oracle.olapi.syntax">SyntaxObject</A> fromSyntax(java.lang.String&nbsp;syntax,
 <A HREF="../../../oracle/olapi/metadata/mdm/MdmMetadataProvider.html" title="class in oracle.olapi.metadata.mdm">MdmMetadataProvider</A>&nbsp;metadataProvider,
 java.lang.String&nbsp;owner,
 boolean&nbsp;isForQuery)</PRE>
<DL>
<DD>Creates a <CODE>SyntaxObject</CODE> from a string in expression
 syntax, provides an owner for the <CODE>SyntaxObject</CODE>, and
 indicates whether the <CODE>SyntaxObject</CODE> is a <CODE>Query</CODE>.

<DD><DL>
<DT>Parameters:<DD><CODE>syntax</CODE> - A <CODE>String</CODE> that contains the expression
 that specifies a <CODE>SyntaxObject</CODE>.<DD><CODE>metadataProvider</CODE> - The <CODE>MdmMetadataProvider</CODE> for the
 current session.<DD><CODE>owner</CODE> - A <CODE>String</CODE> that is the name of the 
 <CODE>MdmDatabaseSchema</CODE> to own the 
 <CODE>SyntaxObject</CODE>.<DD><CODE>isForQuery</CODE> - A <CODE>boolean</CODE> that indicates whether the
 expression describes a <CODE>Query</CODE>.
<DT>Returns:<DD>A <CODE>SyntaxObject</CODE>.</DL>
</DD>
</DL>
<HR>

<A NAME="fromSyntax(java.lang.String, oracle.olapi.metadata.mdm.MdmMetadataProvider, java.lang.String, boolean, java.util.List)"></A><H3>
fromSyntax</H3>
<PRE>
public static <A HREF="../../../oracle/olapi/syntax/SyntaxObject.html" title="class in oracle.olapi.syntax">SyntaxObject</A> fromSyntax(java.lang.String&nbsp;syntax,
 <A HREF="../../../oracle/olapi/metadata/mdm/MdmMetadataProvider.html" title="class in oracle.olapi.metadata.mdm">MdmMetadataProvider</A>&nbsp;metadataProvider,
 java.lang.String&nbsp;owner,
 boolean&nbsp;isForQuery,
 java.util.List&lt;<A HREF="../../../oracle/olapi/syntax/Query.html" title="class in oracle.olapi.syntax">Query</A>&gt;&nbsp;queries)
 throws <A HREF="../../../oracle/olapi/syntax/SyntaxException.html" title="class in oracle.olapi.syntax">SyntaxException</A></PRE>
<DL>
<DD>Creates a <CODE>SyntaxObject</CODE> from a string in expression
 syntax, provides an owner for the <CODE>SyntaxObject</CODE>,
 indicates whether the <CODE>SyntaxObject</CODE> is a <CODE>Query</CODE>,
 and provides the <CODE>Query</CODE> objects that are referenced by
 the expression.

<DD><DL>
<DT>Parameters:<DD><CODE>syntax</CODE> - A <CODE>String</CODE> that contains the expression
 that specifies a <CODE>SyntaxObject</CODE>.<DD><CODE>metadataProvider</CODE> - The <CODE>MdmMetadataProvider</CODE> for the
 current session.<DD><CODE>owner</CODE> - A <CODE>String</CODE> that is the name of the 
 <CODE>MdmDatabaseSchema</CODE> to own the 
 <CODE>SyntaxObject</CODE>.<DD><CODE>isForQuery</CODE> - A <CODE>boolean</CODE> that indicates whether the
 expression describes a <CODE>Query</CODE>.<DD><CODE>queries</CODE> - A <CODE>List</CODE> of <CODE>Query</CODE> objects
 that are referenced by the expression.
<DT>Returns:<DD>A <CODE>SyntaxObject</CODE>.
<DT>Throws:
<DD><CODE><A HREF="../../../oracle/olapi/syntax/SyntaxException.html" title="class in oracle.olapi.syntax">SyntaxException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="fromSyntax(java.lang.String, oracle.olapi.metadata.mdm.MdmMetadataProvider, java.lang.String, boolean, java.util.List, oracle.olapi.metadata.XMLParserCallback)"></A><H3>
fromSyntax</H3>
<PRE>
public static <A HREF="../../../oracle/olapi/syntax/SyntaxObject.html" title="class in oracle.olapi.syntax">SyntaxObject</A> fromSyntax(java.lang.String&nbsp;syntax,
 <A HREF="../../../oracle/olapi/metadata/mdm/MdmMetadataProvider.html" title="class in oracle.olapi.metadata.mdm">MdmMetadataProvider</A>&nbsp;metadataProvider,
 java.lang.String&nbsp;owner,
 boolean&nbsp;isForQuery,
 java.util.List&lt;<A HREF="../../../oracle/olapi/syntax/Query.html" title="class in oracle.olapi.syntax">Query</A>&gt;&nbsp;queries,
 <A HREF="../../../oracle/olapi/metadata/XMLParserCallback.html" title="interface in oracle.olapi.metadata">XMLParserCallback</A>&nbsp;errorCallback)
 throws <A HREF="../../../oracle/olapi/syntax/SyntaxException.html" title="class in oracle.olapi.syntax">SyntaxException</A></PRE>
<DL>
<DD>Creates a <CODE>SyntaxObject</CODE> from a string in expression
 syntax supplied by a <CODE>Reader</CODE>, provides an owner for the 
 <CODE>SyntaxObject</CODE>, indicates whether the 
 <CODE>SyntaxObject</CODE> is a <CODE>Query</CODE>, provides the 
 <CODE>Query</CODE> objects that are referenced by the expression, and
 provides an <CODE>XMLParserCallback</CODE>.

<DD><DL>
<DT>Parameters:<DD><CODE>syntax</CODE> - A <CODE>String</CODE> that contains the expression
 that specifies a <CODE>SyntaxObject</CODE>.<DD><CODE>metadataProvider</CODE> - The <CODE>MdmMetadataProvider</CODE> for the
 current session.<DD><CODE>owner</CODE> - A <CODE>String</CODE> that is the name of the 
 <CODE>MdmDatabaseSchema</CODE> to own the 
 <CODE>SyntaxObject</CODE>.<DD><CODE>isForQuery</CODE> - A <CODE>boolean</CODE> that indicates whether the
 expression describes a <CODE>Query</CODE>.<DD><CODE>queries</CODE> - A <CODE>List</CODE> of <CODE>Query</CODE> objects
 that are referenced by the expression.<DD><CODE>errorCallback</CODE> - A <CODE>XMLParserCallback</CODE> that an
 application can use to process invalid object
 identifiers.
<DT>Returns:<DD>A <CODE>SyntaxObject</CODE>.
<DT>Throws:
<DD><CODE><A HREF="../../../oracle/olapi/syntax/SyntaxException.html" title="class in oracle.olapi.syntax">SyntaxException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="isValid()"></A><H3>
isValid</H3>
<PRE>
public final boolean isValid()</PRE>
<DL>
<DD>Indicates whether the <CODE>SyntaxObject</CODE> has any 
 <CODE>UnresolvedExpression</CODE> objects associated with it.

<DD><DL>

<DT>Returns:<DD>A <CODE>boolean</CODE> that is <CODE>true</CODE> if the 
 <CODE>SyntaxObject</CODE> does not have any 
 <CODE>UnresolvedExpression</CODE> objects or 
 <CODE>false</CODE> if it does.</DL>
</DD>
</DL>
<HR>

<A NAME="equals(oracle.olapi.syntax.SyntaxObject, boolean)"></A><H3>
equals</H3>
<PRE>
public final boolean equals(<A HREF="../../../oracle/olapi/syntax/SyntaxObject.html" title="class in oracle.olapi.syntax">SyntaxObject</A>&nbsp;synObject,
 boolean&nbsp;bIgnorecase)</PRE>
<DL>
<DD>Compares the string representation of the specified 
 <CODE>SyntaxObject</CODE> with that of this <CODE>SyntaxObject</CODE>.

<DD><DL>
<DT>Parameters:<DD><CODE>synObject</CODE> - The <CODE>SyntaxObject</CODE> to compare with this one.<DD><CODE>bIgnorecase</CODE> - A <CODE>boolean</CODE> that indicates whether or not 
 to ignore case in the comparison.
 Specify <CODE>true</CODE> to ignore case differences
 or <CODE>false</CODE> to consider case.
<DT>Returns:<DD>A <CODE>boolean</CODE> that is <CODE>true</CODE> if the string
 representations are the same or <CODE>false</CODE> if they are
 not the same.</DL>
</DD>
</DL>
<HR>

<A NAME="equals(oracle.olapi.syntax.SyntaxObject)"></A><H3>
equals</H3>
<PRE>
public final boolean equals(<A HREF="../../../oracle/olapi/syntax/SyntaxObject.html" title="class in oracle.olapi.syntax">SyntaxObject</A>&nbsp;synObject)</PRE>
<DL>
<DD>Performs a case-sensitive comparison between the string representation of 
 the specified <CODE>SyntaxObject</CODE> and that of this 
 <CODE>SyntaxObject</CODE>.

<DD><DL>
<DT>Parameters:<DD><CODE>synObject</CODE> - The <CODE>SyntaxObject</CODE> to compare with this one.
<DT>Returns:<DD>A <CODE>boolean</CODE> that is <CODE>true</CODE> if the string
 representations are the same or <CODE>false</CODE> if they are
 not the same.</DL>
</DD>
</DL>

<HR>

<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">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>
<center>Copyright &copy; 2002, 2009, Oracle. All rights reserved.</center>
</TD>
</TR>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>

<HR>

</BODY>
</HTML>

Ms-Dos/Windows Unix Write backup

jsp File Browser version 1.2 by www.vonloesch.de