blob: 8dc480636de4d08ddc986f349c698be46002da2e [file] [log] [blame]
<!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_10) on Wed Apr 30 14:46:58 PDT 2008 -->
<TITLE>
AbstractDataModelVariableFactory
</TITLE>
<META NAME="keywords" CONTENT="org.eclipse.jst.jsf.designtime.symbols.AbstractDataModelVariableFactory class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="AbstractDataModelVariableFactory";
}
</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractDataModelVariableFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../../../org/eclipse/jst/jsf/designtime/symbols/DefaultBeanSymbolSourceProvider.html" title="class in org.eclipse.jst.jsf.designtime.symbols"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html?org/eclipse/jst/jsf/designtime/symbols/AbstractDataModelVariableFactory.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="AbstractDataModelVariableFactory.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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">
org.eclipse.jst.jsf.designtime.symbols</FONT>
<BR>
Class AbstractDataModelVariableFactory</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.jst.jsf.designtime.symbols.AbstractDataModelVariableFactory</B>
</PRE>
<HR>
<DL>
<DT><PRE>public abstract class <B>AbstractDataModelVariableFactory</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
A framework provided variable factory for EL model objects that are
constructed based on DataModel's dervied from an EL expression.
<P>
<P>
<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="../../../../../../org/eclipse/jst/jsf/designtime/symbols/AbstractDataModelVariableFactory.html#AbstractDataModelVariableFactory()">AbstractDataModelVariableFactory</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>&nbsp;<A HREF="../../../../../../org/eclipse/jst/jsf/context/symbol/ISymbol.html" title="interface in org.eclipse.jst.jsf.context.symbol">ISymbol</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/designtime/symbols/AbstractDataModelVariableFactory.html#createDefaultSymbol(java.lang.String)">createDefaultSymbol</A></B>(java.lang.String&nbsp;symbolName)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>use JSFSymbolFactory.createDefaultSymbol instead.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../../org/eclipse/jst/jsf/context/symbol/ISymbol.html" title="interface in org.eclipse.jst.jsf.context.symbol">ISymbol</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/designtime/symbols/AbstractDataModelVariableFactory.html#createFromType(java.lang.String, org.eclipse.jst.jsf.common.internal.types.ValueType, IJavaProject)">createFromType</A></B>(java.lang.String&nbsp;symbolName,
org.eclipse.jst.jsf.common.internal.types.ValueType&nbsp;valueType,
IJavaProject&nbsp;javaProject)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Implements default rules for taking an non-array value expression and
resolving it to a ISymbol modelling a JSF DataModel</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;org.eclipse.jst.jsf.common.internal.types.ValueType</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/designtime/symbols/AbstractDataModelVariableFactory.html#createValueExpression(java.lang.String, org.eclipse.jst.jsf.context.structureddocument.IStructuredDocumentContext, IFile)">createValueExpression</A></B>(java.lang.String&nbsp;elText,
<A HREF="../../../../../../org/eclipse/jst/jsf/context/structureddocument/IStructuredDocumentContext.html" title="interface in org.eclipse.jst.jsf.context.structureddocument">IStructuredDocumentContext</A>&nbsp;elContext,
IFile&nbsp;file)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>use JSFSymbolFactory.getValueTypeFromEL instead.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../../org/eclipse/jst/jsf/designtime/symbols/JSFSymbolFactory.html" title="class in org.eclipse.jst.jsf.designtime.symbols">JSFSymbolFactory</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/designtime/symbols/AbstractDataModelVariableFactory.html#getSymbolFactory()">getSymbolFactory</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<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="AbstractDataModelVariableFactory()"><!-- --></A><H3>
AbstractDataModelVariableFactory</H3>
<PRE>
public <B>AbstractDataModelVariableFactory</B>()</PRE>
<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="createValueExpression(java.lang.String, org.eclipse.jst.jsf.context.structureddocument.IStructuredDocumentContext, IFile)"><!-- --></A><H3>
createValueExpression</H3>
<PRE>
public final org.eclipse.jst.jsf.common.internal.types.ValueType <B>createValueExpression</B>(java.lang.String&nbsp;elText,
<A HREF="../../../../../../org/eclipse/jst/jsf/context/structureddocument/IStructuredDocumentContext.html" title="interface in org.eclipse.jst.jsf.context.structureddocument">IStructuredDocumentContext</A>&nbsp;elContext,
IFile&nbsp;file)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>use JSFSymbolFactory.getValueTypeFromEL instead.</I>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>elText</CODE> - The EL expression text. Must not be null<DD><CODE>elContext</CODE> - The document context pointing to elText in the source
document. Must not be null<DD><CODE>file</CODE> - The workspace resource that contains elText. Must not be null.
<DT><B>Returns:</B><DD>the value expression resolved from elText or null if it cannot be
resolved or elText doesn't resolve to value expression (i.e. is a
method expression)</DL>
</DD>
</DL>
<HR>
<A NAME="getSymbolFactory()"><!-- --></A><H3>
getSymbolFactory</H3>
<PRE>
public final <A HREF="../../../../../../org/eclipse/jst/jsf/designtime/symbols/JSFSymbolFactory.html" title="class in org.eclipse.jst.jsf.designtime.symbols">JSFSymbolFactory</A> <B>getSymbolFactory</B>()</PRE>
<DL>
<DD><DL>
<DT><B>Returns:</B><DD>the symbol factory used by this variable factory</DL>
</DD>
</DL>
<HR>
<A NAME="createFromType(java.lang.String, org.eclipse.jst.jsf.common.internal.types.ValueType, IJavaProject)"><!-- --></A><H3>
createFromType</H3>
<PRE>
public <A HREF="../../../../../../org/eclipse/jst/jsf/context/symbol/ISymbol.html" title="interface in org.eclipse.jst.jsf.context.symbol">ISymbol</A> <B>createFromType</B>(java.lang.String&nbsp;symbolName,
org.eclipse.jst.jsf.common.internal.types.ValueType&nbsp;valueType,
IJavaProject&nbsp;javaProject)</PRE>
<DL>
<DD>Implements default rules for taking an non-array value expression and
resolving it to a ISymbol modelling a JSF DataModel
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>symbolName</CODE> - <DD><CODE>valueType</CODE> - <DD><CODE>javaProject</CODE> -
<DT><B>Returns:</B><DD>a symbol where valueType is considered to be the base type upon
which a data model would be created. This combines the
possibility that the value expression is either an explicit
DataModel implementation or a non-DataModel type for which JSF be
default provides an implicit wrapper model.
List is treated as a special case here, since their are two subcases: 1)
the list is a raw type, in which case it must be treated as implicit and
opaque (as to the type of the variable created) 2) the list has Java 5
type argument information that can be used to infer the type of the row
variable</DL>
</DD>
</DL>
<HR>
<A NAME="createDefaultSymbol(java.lang.String)"><!-- --></A><H3>
createDefaultSymbol</H3>
<PRE>
public final <A HREF="../../../../../../org/eclipse/jst/jsf/context/symbol/ISymbol.html" title="interface in org.eclipse.jst.jsf.context.symbol">ISymbol</A> <B>createDefaultSymbol</B>(java.lang.String&nbsp;symbolName)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>use JSFSymbolFactory.createDefaultSymbol instead.</I>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>symbolName</CODE> - The name of the symbol to create. Must not be null
<DT><B>Returns:</B><DD>a default symbol that eliminates bogus warnings for this
dataTable's row variable in cases where something better is
resolvable. Note that this is not ideal, since will result in any
property being accepted on the variable with this name.</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractDataModelVariableFactory.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../../../org/eclipse/jst/jsf/designtime/symbols/DefaultBeanSymbolSourceProvider.html" title="class in org.eclipse.jst.jsf.designtime.symbols"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../../index.html?org/eclipse/jst/jsf/designtime/symbols/AbstractDataModelVariableFactory.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="AbstractDataModelVariableFactory.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>