| <!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_06) on Wed Jul 19 14:42:42 EDT 2006 --> |
| <TITLE> |
| Configuration (Cayenne API Documentation - v.1.2) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.objectstyle.cayenne.conf.Configuration class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="Configuration (Cayenne API Documentation - v.1.2)"; |
| } |
| </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-files/index-1.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> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/objectstyle/cayenne/conf/ConfigStatus.html" title="class in org.objectstyle.cayenne.conf"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/objectstyle/cayenne/conf/ConnectionProperties.html" title="class in org.objectstyle.cayenne.conf"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/objectstyle/cayenne/conf/Configuration.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Configuration.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <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"> |
| org.objectstyle.cayenne.conf</FONT> |
| <BR> |
| Class Configuration</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.conf.Configuration</B> |
| </PRE> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/objectstyle/cayenne/conf/DefaultConfiguration.html" title="class in org.objectstyle.cayenne.conf">DefaultConfiguration</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public abstract class <B>Configuration</B><DT>extends java.lang.Object</DL> |
| </PRE> |
| |
| <P> |
| This class is an entry point to Cayenne. It loads all configuration files and |
| instantiates main Cayenne objects. Used as a singleton via the |
| <A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#getSharedConfiguration()"><CODE>getSharedConfiguration()</CODE></A>method. |
| <p> |
| To use a custom subclass of Configuration, Java applications must call |
| <A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#initializeSharedConfiguration()"><CODE>initializeSharedConfiguration()</CODE></A>with the subclass as argument. This will create |
| and initialize a Configuration singleton instance of the specified class. By default |
| <A HREF="../../../../org/objectstyle/cayenne/conf/DefaultConfiguration.html" title="class in org.objectstyle.cayenne.conf"><CODE>DefaultConfiguration</CODE></A>is instantiated. |
| </p> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Andrei Adamchik, Holger Hoffstaette</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_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>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static org.apache.commons.collections.Predicate</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#ACCEPT_ALL_DATAVIEWS">ACCEPT_ALL_DATAVIEWS</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected org.objectstyle.cayenne.conf.Configuration.ConfigurationShutdownHook</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#configurationShutdownHook">configurationShutdownHook</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/objectstyle/cayenne/util/CayenneMap.html" title="class in org.objectstyle.cayenne.util">CayenneMap</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#dataDomains">dataDomains</A></B></CODE> |
| |
| <BR> |
| Lookup map that stores DataDomains with names as keys.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.util.Map</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#dataViewLocations">dataViewLocations</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.Class</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#DEFAULT_CONFIGURATION_CLASS">DEFAULT_CONFIGURATION_CLASS</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#DEFAULT_DOMAIN_FILE">DEFAULT_DOMAIN_FILE</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#DEFAULT_LOGGING_PROPS_FILE">DEFAULT_LOGGING_PROPS_FILE</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#domainConfigurationName">domainConfigurationName</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/objectstyle/cayenne/event/EventManager.html" title="class in org.objectstyle.cayenne.event">EventManager</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#eventManager">eventManager</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#ignoringLoadFailures">ignoringLoadFailures</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/objectstyle/cayenne/conf/ConfigLoaderDelegate.html" title="interface in org.objectstyle.cayenne.conf">ConfigLoaderDelegate</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#loaderDelegate">loaderDelegate</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/objectstyle/cayenne/conf/ConfigStatus.html" title="class in org.objectstyle.cayenne.conf">ConfigStatus</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#loadStatus">loadStatus</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/objectstyle/cayenne/conf/DataSourceFactory.html" title="interface in org.objectstyle.cayenne.conf">DataSourceFactory</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#overrideFactory">overrideFactory</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#projectVersion">projectVersion</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected <A HREF="../../../../org/objectstyle/cayenne/conf/ConfigSaverDelegate.html" title="interface in org.objectstyle.cayenne.conf">ConfigSaverDelegate</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#saverDelegate">saverDelegate</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected static <A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html" title="class in org.objectstyle.cayenne.conf">Configuration</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#sharedConfiguration">sharedConfiguration</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== 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 ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected </CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#Configuration()">Configuration</A></B>()</CODE> |
| |
| <BR> |
| Default constructor for new Configuration instances.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected </CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#Configuration(java.lang.String)">Configuration</A></B>(java.lang.String domainConfigurationName)</CODE> |
| |
| <BR> |
| Default constructor for new Configuration instances using the given resource name |
| as the main domain file.</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="../../../../org/objectstyle/cayenne/conf/Configuration.html#addDomain(org.objectstyle.cayenne.access.DataDomain)">addDomain</A></B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataDomain.html" title="class in org.objectstyle.cayenne.access">DataDomain</A> domain)</CODE> |
| |
| <BR> |
| Adds new DataDomain to the list of registered domains.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#bootstrapSharedConfiguration(java.lang.Class)">bootstrapSharedConfiguration</A></B>(java.lang.Class cl)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>since 1.2. Use Thread.currentThread().setContextClassLoader() instead.</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#canInitialize()">canInitialize</A></B>()</CODE> |
| |
| <BR> |
| Indicates whether <A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#initialize()"><CODE>initialize()</CODE></A>can be called.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#configureCommonLogging()">configureCommonLogging</A></B>()</CODE> |
| |
| <BR> |
| Configures Cayenne logging properties.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#configureCommonLogging(java.net.URL)">configureCommonLogging</A></B>(java.net.URL propsFile)</CODE> |
| |
| <BR> |
| Configures Cayenne logging properties using properties found at the specified URL.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#configureLogging()">configureLogging</A></B>()</CODE> |
| |
| <BR> |
| Configures log4J.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#didInitialize()">didInitialize</A></B>()</CODE> |
| |
| <BR> |
| Called after successful completion of <A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#initialize()"><CODE>initialize()</CODE></A>.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/objectstyle/cayenne/conf/DataSourceFactory.html" title="interface in org.objectstyle.cayenne.conf">DataSourceFactory</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#getDataSourceFactory()">getDataSourceFactory</A></B>()</CODE> |
| |
| <BR> |
| Returns an internal property for the DataSource factory that will override any |
| settings configured in XML.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Map</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#getDataViewLocations()">getDataViewLocations</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/objectstyle/cayenne/access/DataDomain.html" title="class in org.objectstyle.cayenne.access">DataDomain</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#getDomain()">getDomain</A></B>()</CODE> |
| |
| <BR> |
| Returns default domain of this configuration.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/objectstyle/cayenne/access/DataDomain.html" title="class in org.objectstyle.cayenne.access">DataDomain</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#getDomain(java.lang.String)">getDomain</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Returns registered domain matching <code>name</code> or <code>null</code> if no |
| such domain is found.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected abstract java.io.InputStream</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#getDomainConfiguration()">getDomainConfiguration</A></B>()</CODE> |
| |
| <BR> |
| Returns a DataDomain as a stream or <code>null</code> if it cannot be found.</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="../../../../org/objectstyle/cayenne/conf/Configuration.html#getDomainConfigurationName()">getDomainConfigurationName</A></B>()</CODE> |
| |
| <BR> |
| Returns the name of the main domain configuration resource.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Collection</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#getDomains()">getDomains</A></B>()</CODE> |
| |
| <BR> |
| Returns an unmodifiable collection of registered <A HREF="../../../../org/objectstyle/cayenne/access/DataDomain.html" title="class in org.objectstyle.cayenne.access"><CODE>DataDomain</CODE></A>objects.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/objectstyle/cayenne/event/EventManager.html" title="class in org.objectstyle.cayenne.event">EventManager</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#getEventManager()">getEventManager</A></B>()</CODE> |
| |
| <BR> |
| Returns EventManager used by this configuration.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/objectstyle/cayenne/conf/ConfigLoaderDelegate.html" title="interface in org.objectstyle.cayenne.conf">ConfigLoaderDelegate</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#getLoaderDelegate()">getLoaderDelegate</A></B>()</CODE> |
| |
| <BR> |
| Returns a delegate used for controlling the loading of configuration elements.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/objectstyle/cayenne/conf/ConfigStatus.html" title="class in org.objectstyle.cayenne.conf">ConfigStatus</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#getLoadStatus()">getLoadStatus</A></B>()</CODE> |
| |
| <BR> |
| Returns the load status.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static org.apache.log4j.Level</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#getLoggingLevel()">getLoggingLevel</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>since 1.2 unused</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected abstract java.io.InputStream</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#getMapConfiguration(java.lang.String)">getMapConfiguration</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Returns a DataMap with the given name or <code>null</code> if it cannot be found.</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="../../../../org/objectstyle/cayenne/conf/Configuration.html#getProjectVersion()">getProjectVersion</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.ClassLoader</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#getResourceLoader()">getResourceLoader</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>since 1.2 use Thread.currentThread().getContextClassLoader(). This is |
| what Cayenne uses internally.</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected abstract <A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html" title="class in org.objectstyle.cayenne.util">ResourceLocator</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#getResourceLocator()">getResourceLocator</A></B>()</CODE> |
| |
| <BR> |
| Returns the resource locator used for finding and loading resources.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/objectstyle/cayenne/conf/ConfigSaverDelegate.html" title="interface in org.objectstyle.cayenne.conf">ConfigSaverDelegate</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#getSaverDelegate()">getSaverDelegate</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html" title="class in org.objectstyle.cayenne.conf">Configuration</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#getSharedConfiguration()">getSharedConfiguration</A></B>()</CODE> |
| |
| <BR> |
| Use this method as an entry point to all Cayenne access objects.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected abstract java.io.InputStream</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#getViewConfiguration(java.lang.String)">getViewConfiguration</A></B>(java.lang.String location)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#initialize()">initialize</A></B>()</CODE> |
| |
| <BR> |
| Initializes the new instance.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#initializeSharedConfiguration()">initializeSharedConfiguration</A></B>()</CODE> |
| |
| <BR> |
| Creates and initializes shared Configuration object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#initializeSharedConfiguration(java.lang.Class)">initializeSharedConfiguration</A></B>(java.lang.Class configurationClass)</CODE> |
| |
| <BR> |
| Creates and initializes a shared Configuration object of a custom Configuration |
| subclass.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#initializeSharedConfiguration(org.objectstyle.cayenne.conf.Configuration)">initializeSharedConfiguration</A></B>(<A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html" title="class in org.objectstyle.cayenne.conf">Configuration</A> conf)</CODE> |
| |
| <BR> |
| Sets the shared Configuration object to a new Configuration object.</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="../../../../org/objectstyle/cayenne/conf/Configuration.html#installConfigurationShutdownHook()">installConfigurationShutdownHook</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#isIgnoringLoadFailures()">isIgnoringLoadFailures</A></B>()</CODE> |
| |
| <BR> |
| Returns whether to ignore any failures during map loading or not.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#isLoggingConfigured()">isLoggingConfigured</A></B>()</CODE> |
| |
| <BR> |
| Indicates whether Log4j has been initialized, either by cayenne or otherwise.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#loadDataView(org.objectstyle.cayenne.dataview.DataView)">loadDataView</A></B>(<A HREF="../../../../org/objectstyle/cayenne/dataview/DataView.html" title="class in org.objectstyle.cayenne.dataview">DataView</A> dataView)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#loadDataView(org.objectstyle.cayenne.dataview.DataView, org.apache.commons.collections.Predicate)">loadDataView</A></B>(<A HREF="../../../../org/objectstyle/cayenne/dataview/DataView.html" title="class in org.objectstyle.cayenne.dataview">DataView</A> dataView, |
| org.apache.commons.collections.Predicate dataViewNameFilter)</CODE> |
| |
| <BR> |
| </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="../../../../org/objectstyle/cayenne/conf/Configuration.html#removeDomain(java.lang.String)">removeDomain</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Unregisters DataDomain matching <code>name<code> from |
| this Configuration object.</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="../../../../org/objectstyle/cayenne/conf/Configuration.html#setDataSourceFactory(org.objectstyle.cayenne.conf.DataSourceFactory)">setDataSourceFactory</A></B>(<A HREF="../../../../org/objectstyle/cayenne/conf/DataSourceFactory.html" title="interface in org.objectstyle.cayenne.conf">DataSourceFactory</A> overrideFactory)</CODE> |
| |
| <BR> |
| </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="../../../../org/objectstyle/cayenne/conf/Configuration.html#setDataViewLocations(java.util.Map)">setDataViewLocations</A></B>(java.util.Map dataViewLocations)</CODE> |
| |
| <BR> |
| Initializes configuration with the location of data views.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#setDomainConfigurationName(java.lang.String)">setDomainConfigurationName</A></B>(java.lang.String domainConfigurationName)</CODE> |
| |
| <BR> |
| Sets the name of the main domain configuration resource.</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="../../../../org/objectstyle/cayenne/conf/Configuration.html#setEventManager(org.objectstyle.cayenne.event.EventManager)">setEventManager</A></B>(<A HREF="../../../../org/objectstyle/cayenne/event/EventManager.html" title="class in org.objectstyle.cayenne.event">EventManager</A> eventManager)</CODE> |
| |
| <BR> |
| Sets EventManager used by this configuration.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#setIgnoringLoadFailures(boolean)">setIgnoringLoadFailures</A></B>(boolean ignoringLoadFailures)</CODE> |
| |
| <BR> |
| Sets whether to ignore any failures during map loading or not.</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="../../../../org/objectstyle/cayenne/conf/Configuration.html#setLoaderDelegate(org.objectstyle.cayenne.conf.ConfigLoaderDelegate)">setLoaderDelegate</A></B>(<A HREF="../../../../org/objectstyle/cayenne/conf/ConfigLoaderDelegate.html" title="interface in org.objectstyle.cayenne.conf">ConfigLoaderDelegate</A> loaderDelegate)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#setLoadStatus(org.objectstyle.cayenne.conf.ConfigStatus)">setLoadStatus</A></B>(<A HREF="../../../../org/objectstyle/cayenne/conf/ConfigStatus.html" title="class in org.objectstyle.cayenne.conf">ConfigStatus</A> status)</CODE> |
| |
| <BR> |
| Sets the load status.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#setLoggingConfigured(boolean)">setLoggingConfigured</A></B>(boolean state)</CODE> |
| |
| <BR> |
| Indicate whether Log4j has been initialized.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#setLoggingLevel(org.apache.log4j.Level)">setLoggingLevel</A></B>(org.apache.log4j.Level logLevel)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>since 1.2 unused.</I></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="../../../../org/objectstyle/cayenne/conf/Configuration.html#setProjectVersion(java.lang.String)">setProjectVersion</A></B>(java.lang.String projectVersion)</CODE> |
| |
| <BR> |
| </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="../../../../org/objectstyle/cayenne/conf/Configuration.html#setSaverDelegate(org.objectstyle.cayenne.conf.ConfigSaverDelegate)">setSaverDelegate</A></B>(<A HREF="../../../../org/objectstyle/cayenne/conf/ConfigSaverDelegate.html" title="interface in org.objectstyle.cayenne.conf">ConfigSaverDelegate</A> saverDelegate)</CODE> |
| |
| <BR> |
| </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="../../../../org/objectstyle/cayenne/conf/Configuration.html#shutdown()">shutdown</A></B>()</CODE> |
| |
| <BR> |
| Shutdowns all owned domains.</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="../../../../org/objectstyle/cayenne/conf/Configuration.html#uninstallConfigurationShutdownHook()">uninstallConfigurationShutdownHook</A></B>()</CODE> |
| |
| <BR> |
| </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> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_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>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="DEFAULT_LOGGING_PROPS_FILE"><!-- --></A><H3> |
| DEFAULT_LOGGING_PROPS_FILE</H3> |
| <PRE> |
| public static final java.lang.String <B>DEFAULT_LOGGING_PROPS_FILE</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.objectstyle.cayenne.conf.Configuration.DEFAULT_LOGGING_PROPS_FILE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="DEFAULT_DOMAIN_FILE"><!-- --></A><H3> |
| DEFAULT_DOMAIN_FILE</H3> |
| <PRE> |
| public static final java.lang.String <B>DEFAULT_DOMAIN_FILE</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.objectstyle.cayenne.conf.Configuration.DEFAULT_DOMAIN_FILE">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="DEFAULT_CONFIGURATION_CLASS"><!-- --></A><H3> |
| DEFAULT_CONFIGURATION_CLASS</H3> |
| <PRE> |
| public static final java.lang.Class <B>DEFAULT_CONFIGURATION_CLASS</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="sharedConfiguration"><!-- --></A><H3> |
| sharedConfiguration</H3> |
| <PRE> |
| protected static <A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html" title="class in org.objectstyle.cayenne.conf">Configuration</A> <B>sharedConfiguration</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="ACCEPT_ALL_DATAVIEWS"><!-- --></A><H3> |
| ACCEPT_ALL_DATAVIEWS</H3> |
| <PRE> |
| public static final org.apache.commons.collections.Predicate <B>ACCEPT_ALL_DATAVIEWS</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="dataDomains"><!-- --></A><H3> |
| dataDomains</H3> |
| <PRE> |
| protected <A HREF="../../../../org/objectstyle/cayenne/util/CayenneMap.html" title="class in org.objectstyle.cayenne.util">CayenneMap</A> <B>dataDomains</B></PRE> |
| <DL> |
| <DD>Lookup map that stores DataDomains with names as keys. |
| <P> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="overrideFactory"><!-- --></A><H3> |
| overrideFactory</H3> |
| <PRE> |
| protected <A HREF="../../../../org/objectstyle/cayenne/conf/DataSourceFactory.html" title="interface in org.objectstyle.cayenne.conf">DataSourceFactory</A> <B>overrideFactory</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="loadStatus"><!-- --></A><H3> |
| loadStatus</H3> |
| <PRE> |
| protected <A HREF="../../../../org/objectstyle/cayenne/conf/ConfigStatus.html" title="class in org.objectstyle.cayenne.conf">ConfigStatus</A> <B>loadStatus</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="domainConfigurationName"><!-- --></A><H3> |
| domainConfigurationName</H3> |
| <PRE> |
| protected java.lang.String <B>domainConfigurationName</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="ignoringLoadFailures"><!-- --></A><H3> |
| ignoringLoadFailures</H3> |
| <PRE> |
| protected boolean <B>ignoringLoadFailures</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="loaderDelegate"><!-- --></A><H3> |
| loaderDelegate</H3> |
| <PRE> |
| protected <A HREF="../../../../org/objectstyle/cayenne/conf/ConfigLoaderDelegate.html" title="interface in org.objectstyle.cayenne.conf">ConfigLoaderDelegate</A> <B>loaderDelegate</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="saverDelegate"><!-- --></A><H3> |
| saverDelegate</H3> |
| <PRE> |
| protected <A HREF="../../../../org/objectstyle/cayenne/conf/ConfigSaverDelegate.html" title="interface in org.objectstyle.cayenne.conf">ConfigSaverDelegate</A> <B>saverDelegate</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="configurationShutdownHook"><!-- --></A><H3> |
| configurationShutdownHook</H3> |
| <PRE> |
| protected org.objectstyle.cayenne.conf.Configuration.ConfigurationShutdownHook <B>configurationShutdownHook</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="dataViewLocations"><!-- --></A><H3> |
| dataViewLocations</H3> |
| <PRE> |
| protected java.util.Map <B>dataViewLocations</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="projectVersion"><!-- --></A><H3> |
| projectVersion</H3> |
| <PRE> |
| protected java.lang.String <B>projectVersion</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="eventManager"><!-- --></A><H3> |
| eventManager</H3> |
| <PRE> |
| protected <A HREF="../../../../org/objectstyle/cayenne/event/EventManager.html" title="class in org.objectstyle.cayenne.event">EventManager</A> <B>eventManager</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DL> |
| |
| <!-- ========= 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="Configuration()"><!-- --></A><H3> |
| Configuration</H3> |
| <PRE> |
| protected <B>Configuration</B>()</PRE> |
| <DL> |
| <DD>Default constructor for new Configuration instances. Simply calls |
| <A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#Configuration(java.lang.String)"><CODE>Configuration(String)</CODE></A>. |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#Configuration(java.lang.String)"><CODE>Configuration(String)</CODE></A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="Configuration(java.lang.String)"><!-- --></A><H3> |
| Configuration</H3> |
| <PRE> |
| protected <B>Configuration</B>(java.lang.String domainConfigurationName)</PRE> |
| <DL> |
| <DD>Default constructor for new Configuration instances using the given resource name |
| as the main domain file. First calls <A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#configureLogging()"><CODE>configureLogging()</CODE></A>, then |
| <A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#setDomainConfigurationName(java.lang.String)"><CODE>setDomainConfigurationName(java.lang.String)</CODE></A>with the given domain configuration resource |
| name. |
| <P> |
| </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="bootstrapSharedConfiguration(java.lang.Class)"><!-- --></A><H3> |
| bootstrapSharedConfiguration</H3> |
| <PRE> |
| public static void <B>bootstrapSharedConfiguration</B>(java.lang.Class cl)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>since 1.2. Use Thread.currentThread().setContextClassLoader() instead.</I> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="configureCommonLogging()"><!-- --></A><H3> |
| configureCommonLogging</H3> |
| <PRE> |
| public static void <B>configureCommonLogging</B>()</PRE> |
| <DL> |
| <DD>Configures Cayenne logging properties. Search for the properties file called |
| <code>cayenne-log.properties</code> is first done in $HOME/.cayenne, then in |
| CLASSPATH. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="configureCommonLogging(java.net.URL)"><!-- --></A><H3> |
| configureCommonLogging</H3> |
| <PRE> |
| public static void <B>configureCommonLogging</B>(java.net.URL propsFile)</PRE> |
| <DL> |
| <DD>Configures Cayenne logging properties using properties found at the specified URL. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isLoggingConfigured()"><!-- --></A><H3> |
| isLoggingConfigured</H3> |
| <PRE> |
| public static boolean <B>isLoggingConfigured</B>()</PRE> |
| <DL> |
| <DD>Indicates whether Log4j has been initialized, either by cayenne or otherwise. If an |
| external setup has been detected, <A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#setLoggingConfigured(boolean)"><CODE>setLoggingConfigured(boolean)</CODE></A>will be called to |
| remember this. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setLoggingConfigured(boolean)"><!-- --></A><H3> |
| setLoggingConfigured</H3> |
| <PRE> |
| public static void <B>setLoggingConfigured</B>(boolean state)</PRE> |
| <DL> |
| <DD>Indicate whether Log4j has been initialized. Can be used when subclasses customize |
| the initialization process, or to configure Log4J outside of Cayenne. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSharedConfiguration()"><!-- --></A><H3> |
| getSharedConfiguration</H3> |
| <PRE> |
| public static <A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html" title="class in org.objectstyle.cayenne.conf">Configuration</A> <B>getSharedConfiguration</B>()</PRE> |
| <DL> |
| <DD>Use this method as an entry point to all Cayenne access objects. |
| <p> |
| Note that if you want to provide a custom Configuration, make sure you call one of |
| the <A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#initializeSharedConfiguration()"><CODE>initializeSharedConfiguration()</CODE></A>methods before your application code has |
| a chance to call this method. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getResourceLoader()"><!-- --></A><H3> |
| getResourceLoader</H3> |
| <PRE> |
| public static java.lang.ClassLoader <B>getResourceLoader</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>since 1.2 use Thread.currentThread().getContextClassLoader(). This is |
| what Cayenne uses internally.</I> |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLoggingLevel()"><!-- --></A><H3> |
| getLoggingLevel</H3> |
| <PRE> |
| public static org.apache.log4j.Level <B>getLoggingLevel</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>since 1.2 unused</I> |
| <P> |
| <DD>Returns default log level for loading configuration. Log level is made static so |
| that applications can set it before shared Configuration object is instantiated. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setLoggingLevel(org.apache.log4j.Level)"><!-- --></A><H3> |
| setLoggingLevel</H3> |
| <PRE> |
| public static void <B>setLoggingLevel</B>(org.apache.log4j.Level logLevel)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>since 1.2 unused.</I> |
| <P> |
| <DD>Sets the default log level for loading a configuration. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getEventManager()"><!-- --></A><H3> |
| getEventManager</H3> |
| <PRE> |
| public <A HREF="../../../../org/objectstyle/cayenne/event/EventManager.html" title="class in org.objectstyle.cayenne.event">EventManager</A> <B>getEventManager</B>()</PRE> |
| <DL> |
| <DD>Returns EventManager used by this configuration. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setEventManager(org.objectstyle.cayenne.event.EventManager)"><!-- --></A><H3> |
| setEventManager</H3> |
| <PRE> |
| public void <B>setEventManager</B>(<A HREF="../../../../org/objectstyle/cayenne/event/EventManager.html" title="class in org.objectstyle.cayenne.event">EventManager</A> eventManager)</PRE> |
| <DL> |
| <DD>Sets EventManager used by this configuration. |
| <P> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="initializeSharedConfiguration()"><!-- --></A><H3> |
| initializeSharedConfiguration</H3> |
| <PRE> |
| public static void <B>initializeSharedConfiguration</B>()</PRE> |
| <DL> |
| <DD>Creates and initializes shared Configuration object. By default |
| <A HREF="../../../../org/objectstyle/cayenne/conf/DefaultConfiguration.html" title="class in org.objectstyle.cayenne.conf"><CODE>DefaultConfiguration</CODE></A>will be instantiated and assigned to a singleton |
| instance of Configuration. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="initializeSharedConfiguration(java.lang.Class)"><!-- --></A><H3> |
| initializeSharedConfiguration</H3> |
| <PRE> |
| public static void <B>initializeSharedConfiguration</B>(java.lang.Class configurationClass)</PRE> |
| <DL> |
| <DD>Creates and initializes a shared Configuration object of a custom Configuration |
| subclass. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="initializeSharedConfiguration(org.objectstyle.cayenne.conf.Configuration)"><!-- --></A><H3> |
| initializeSharedConfiguration</H3> |
| <PRE> |
| public static void <B>initializeSharedConfiguration</B>(<A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html" title="class in org.objectstyle.cayenne.conf">Configuration</A> conf)</PRE> |
| <DL> |
| <DD>Sets the shared Configuration object to a new Configuration object. First calls |
| <A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#canInitialize()"><CODE>canInitialize()</CODE></A>and - if permitted -<A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#initialize()"><CODE>initialize()</CODE></A>followed by |
| <A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#didInitialize()"><CODE>didInitialize()</CODE></A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="canInitialize()"><!-- --></A><H3> |
| canInitialize</H3> |
| <PRE> |
| public abstract boolean <B>canInitialize</B>()</PRE> |
| <DL> |
| <DD>Indicates whether <A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#initialize()"><CODE>initialize()</CODE></A>can be called. Returning <code>false</code> |
| allows new instances to delay or refuse the initialization process. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="initialize()"><!-- --></A><H3> |
| initialize</H3> |
| <PRE> |
| public abstract void <B>initialize</B>() |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>Initializes the new instance. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="didInitialize()"><!-- --></A><H3> |
| didInitialize</H3> |
| <PRE> |
| public abstract void <B>didInitialize</B>()</PRE> |
| <DL> |
| <DD>Called after successful completion of <A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#initialize()"><CODE>initialize()</CODE></A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getResourceLocator()"><!-- --></A><H3> |
| getResourceLocator</H3> |
| <PRE> |
| protected abstract <A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html" title="class in org.objectstyle.cayenne.util">ResourceLocator</A> <B>getResourceLocator</B>()</PRE> |
| <DL> |
| <DD>Returns the resource locator used for finding and loading resources. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDomainConfiguration()"><!-- --></A><H3> |
| getDomainConfiguration</H3> |
| <PRE> |
| protected abstract java.io.InputStream <B>getDomainConfiguration</B>()</PRE> |
| <DL> |
| <DD>Returns a DataDomain as a stream or <code>null</code> if it cannot be found. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMapConfiguration(java.lang.String)"><!-- --></A><H3> |
| getMapConfiguration</H3> |
| <PRE> |
| protected abstract java.io.InputStream <B>getMapConfiguration</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Returns a DataMap with the given name or <code>null</code> if it cannot be found. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getViewConfiguration(java.lang.String)"><!-- --></A><H3> |
| getViewConfiguration</H3> |
| <PRE> |
| protected abstract java.io.InputStream <B>getViewConfiguration</B>(java.lang.String location)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="configureLogging()"><!-- --></A><H3> |
| configureLogging</H3> |
| <PRE> |
| protected void <B>configureLogging</B>()</PRE> |
| <DL> |
| <DD>Configures log4J. This implementation calls |
| <A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#configureCommonLogging()"><CODE>configureCommonLogging()</CODE></A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDomainConfigurationName()"><!-- --></A><H3> |
| getDomainConfigurationName</H3> |
| <PRE> |
| public java.lang.String <B>getDomainConfigurationName</B>()</PRE> |
| <DL> |
| <DD>Returns the name of the main domain configuration resource. Defaults to |
| <A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#DEFAULT_DOMAIN_FILE"><CODE>DEFAULT_DOMAIN_FILE</CODE></A>. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDomainConfigurationName(java.lang.String)"><!-- --></A><H3> |
| setDomainConfigurationName</H3> |
| <PRE> |
| protected void <B>setDomainConfigurationName</B>(java.lang.String domainConfigurationName)</PRE> |
| <DL> |
| <DD>Sets the name of the main domain configuration resource. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>domainConfigurationName</CODE> - the name of the resource that contains this |
| Configuration's domain(s).</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getProjectVersion()"><!-- --></A><H3> |
| getProjectVersion</H3> |
| <PRE> |
| public java.lang.String <B>getProjectVersion</B>()</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setProjectVersion(java.lang.String)"><!-- --></A><H3> |
| setProjectVersion</H3> |
| <PRE> |
| public void <B>setProjectVersion</B>(java.lang.String projectVersion)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDataSourceFactory()"><!-- --></A><H3> |
| getDataSourceFactory</H3> |
| <PRE> |
| public <A HREF="../../../../org/objectstyle/cayenne/conf/DataSourceFactory.html" title="interface in org.objectstyle.cayenne.conf">DataSourceFactory</A> <B>getDataSourceFactory</B>()</PRE> |
| <DL> |
| <DD>Returns an internal property for the DataSource factory that will override any |
| settings configured in XML. Subclasses may override this method to provide a |
| special factory for DataSource creation that will take precedence over any |
| factories configured in a cayenne project. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDataSourceFactory(org.objectstyle.cayenne.conf.DataSourceFactory)"><!-- --></A><H3> |
| setDataSourceFactory</H3> |
| <PRE> |
| public void <B>setDataSourceFactory</B>(<A HREF="../../../../org/objectstyle/cayenne/conf/DataSourceFactory.html" title="interface in org.objectstyle.cayenne.conf">DataSourceFactory</A> overrideFactory)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addDomain(org.objectstyle.cayenne.access.DataDomain)"><!-- --></A><H3> |
| addDomain</H3> |
| <PRE> |
| public void <B>addDomain</B>(<A HREF="../../../../org/objectstyle/cayenne/access/DataDomain.html" title="class in org.objectstyle.cayenne.access">DataDomain</A> domain)</PRE> |
| <DL> |
| <DD>Adds new DataDomain to the list of registered domains. Injects EventManager used by |
| this configuration into the domain. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDomain(java.lang.String)"><!-- --></A><H3> |
| getDomain</H3> |
| <PRE> |
| public <A HREF="../../../../org/objectstyle/cayenne/access/DataDomain.html" title="class in org.objectstyle.cayenne.access">DataDomain</A> <B>getDomain</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Returns registered domain matching <code>name</code> or <code>null</code> if no |
| such domain is found. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDomain()"><!-- --></A><H3> |
| getDomain</H3> |
| <PRE> |
| public <A HREF="../../../../org/objectstyle/cayenne/access/DataDomain.html" title="class in org.objectstyle.cayenne.access">DataDomain</A> <B>getDomain</B>()</PRE> |
| <DL> |
| <DD>Returns default domain of this configuration. If no domains are configured, |
| <code>null</code> is returned. If more than one domain exists in this |
| configuration, a CayenneRuntimeException is thrown, indicating that the domain name |
| must be explicitly specified. In such cases <A HREF="../../../../org/objectstyle/cayenne/conf/Configuration.html#getDomain(java.lang.String)"><CODE>getDomain(String name)</CODE></A>must be |
| used instead. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeDomain(java.lang.String)"><!-- --></A><H3> |
| removeDomain</H3> |
| <PRE> |
| public void <B>removeDomain</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Unregisters DataDomain matching <code>name<code> from |
| this Configuration object. Note that any domain database |
| connections remain open, and it is a responsibility of a |
| caller to clean it up. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDomains()"><!-- --></A><H3> |
| getDomains</H3> |
| <PRE> |
| public java.util.Collection <B>getDomains</B>()</PRE> |
| <DL> |
| <DD>Returns an unmodifiable collection of registered <A HREF="../../../../org/objectstyle/cayenne/access/DataDomain.html" title="class in org.objectstyle.cayenne.access"><CODE>DataDomain</CODE></A>objects. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isIgnoringLoadFailures()"><!-- --></A><H3> |
| isIgnoringLoadFailures</H3> |
| <PRE> |
| public boolean <B>isIgnoringLoadFailures</B>()</PRE> |
| <DL> |
| <DD>Returns whether to ignore any failures during map loading or not. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>boolean</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setIgnoringLoadFailures(boolean)"><!-- --></A><H3> |
| setIgnoringLoadFailures</H3> |
| <PRE> |
| protected void <B>setIgnoringLoadFailures</B>(boolean ignoringLoadFailures)</PRE> |
| <DL> |
| <DD>Sets whether to ignore any failures during map loading or not. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>ignoringLoadFailures</CODE> - <code>true</code> or <code>false</code></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLoadStatus()"><!-- --></A><H3> |
| getLoadStatus</H3> |
| <PRE> |
| public <A HREF="../../../../org/objectstyle/cayenne/conf/ConfigStatus.html" title="class in org.objectstyle.cayenne.conf">ConfigStatus</A> <B>getLoadStatus</B>()</PRE> |
| <DL> |
| <DD>Returns the load status. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>ConfigStatus</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setLoadStatus(org.objectstyle.cayenne.conf.ConfigStatus)"><!-- --></A><H3> |
| setLoadStatus</H3> |
| <PRE> |
| protected void <B>setLoadStatus</B>(<A HREF="../../../../org/objectstyle/cayenne/conf/ConfigStatus.html" title="class in org.objectstyle.cayenne.conf">ConfigStatus</A> status)</PRE> |
| <DL> |
| <DD>Sets the load status. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLoaderDelegate()"><!-- --></A><H3> |
| getLoaderDelegate</H3> |
| <PRE> |
| public <A HREF="../../../../org/objectstyle/cayenne/conf/ConfigLoaderDelegate.html" title="interface in org.objectstyle.cayenne.conf">ConfigLoaderDelegate</A> <B>getLoaderDelegate</B>()</PRE> |
| <DL> |
| <DD>Returns a delegate used for controlling the loading of configuration elements. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setLoaderDelegate(org.objectstyle.cayenne.conf.ConfigLoaderDelegate)"><!-- --></A><H3> |
| setLoaderDelegate</H3> |
| <PRE> |
| public void <B>setLoaderDelegate</B>(<A HREF="../../../../org/objectstyle/cayenne/conf/ConfigLoaderDelegate.html" title="interface in org.objectstyle.cayenne.conf">ConfigLoaderDelegate</A> loaderDelegate)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getSaverDelegate()"><!-- --></A><H3> |
| getSaverDelegate</H3> |
| <PRE> |
| public <A HREF="../../../../org/objectstyle/cayenne/conf/ConfigSaverDelegate.html" title="interface in org.objectstyle.cayenne.conf">ConfigSaverDelegate</A> <B>getSaverDelegate</B>()</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSaverDelegate(org.objectstyle.cayenne.conf.ConfigSaverDelegate)"><!-- --></A><H3> |
| setSaverDelegate</H3> |
| <PRE> |
| public void <B>setSaverDelegate</B>(<A HREF="../../../../org/objectstyle/cayenne/conf/ConfigSaverDelegate.html" title="interface in org.objectstyle.cayenne.conf">ConfigSaverDelegate</A> saverDelegate)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDataViewLocations(java.util.Map)"><!-- --></A><H3> |
| setDataViewLocations</H3> |
| <PRE> |
| public void <B>setDataViewLocations</B>(java.util.Map dataViewLocations)</PRE> |
| <DL> |
| <DD>Initializes configuration with the location of data views. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>dataViewLocations</CODE> - Map of DataView locations.<DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDataViewLocations()"><!-- --></A><H3> |
| getDataViewLocations</H3> |
| <PRE> |
| public java.util.Map <B>getDataViewLocations</B>()</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadDataView(org.objectstyle.cayenne.dataview.DataView)"><!-- --></A><H3> |
| loadDataView</H3> |
| <PRE> |
| public boolean <B>loadDataView</B>(<A HREF="../../../../org/objectstyle/cayenne/dataview/DataView.html" title="class in org.objectstyle.cayenne.dataview">DataView</A> dataView) |
| throws java.io.IOException</PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.io.IOException</CODE><DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="loadDataView(org.objectstyle.cayenne.dataview.DataView, org.apache.commons.collections.Predicate)"><!-- --></A><H3> |
| loadDataView</H3> |
| <PRE> |
| public boolean <B>loadDataView</B>(<A HREF="../../../../org/objectstyle/cayenne/dataview/DataView.html" title="class in org.objectstyle.cayenne.dataview">DataView</A> dataView, |
| org.apache.commons.collections.Predicate dataViewNameFilter) |
| throws java.io.IOException</PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.io.IOException</CODE><DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="shutdown()"><!-- --></A><H3> |
| shutdown</H3> |
| <PRE> |
| public void <B>shutdown</B>()</PRE> |
| <DL> |
| <DD>Shutdowns all owned domains. Invokes DataDomain.shutdown(). |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="installConfigurationShutdownHook()"><!-- --></A><H3> |
| installConfigurationShutdownHook</H3> |
| <PRE> |
| public void <B>installConfigurationShutdownHook</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="uninstallConfigurationShutdownHook()"><!-- --></A><H3> |
| uninstallConfigurationShutdownHook</H3> |
| <PRE> |
| public void <B>uninstallConfigurationShutdownHook</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </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-files/index-1.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> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/objectstyle/cayenne/conf/ConfigStatus.html" title="class in org.objectstyle.cayenne.conf"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/objectstyle/cayenne/conf/ConnectionProperties.html" title="class in org.objectstyle.cayenne.conf"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/objectstyle/cayenne/conf/Configuration.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Configuration.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <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> |
| |
| <!--@SFLOGO@--> <i>Copyright © 2001-2006 <a href= |
| "http://objectstyle.org" target="_top">ObjectStyle.org</a> All Rights Reserved.</i> |
| |
| </BODY> |
| </HTML> |