blob: 9a75652f06990e73a36bd7bd7aede063ca673b4d [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.6.0_24) on Sat Jun 11 11:32:57 EEST 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
FileConfiguration (Cayenne Documentation 3.0.2 API)
</TITLE>
<META NAME="date" CONTENT="2011-06-11">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FileConfiguration (Cayenne Documentation 3.0.2 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= 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/FileConfiguration.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-all.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;<A HREF="../../../../org/apache/cayenne/conf/DriverDataSourceFactory.html" title="class in org.apache.cayenne.conf"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/cayenne/conf/JNDIDataSourceFactory.html" title="class in org.apache.cayenne.conf"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/cayenne/conf/FileConfiguration.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="FileConfiguration.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;<A HREF="#field_summary">FIELD</A>&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;<A HREF="#field_detail">FIELD</A>&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.apache.cayenne.conf</FONT>
<BR>
Class FileConfiguration</H2>
<PRE>
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/cayenne/conf/Configuration.html" title="class in org.apache.cayenne.conf">org.apache.cayenne.conf.Configuration</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/cayenne/conf/DefaultConfiguration.html" title="class in org.apache.cayenne.conf">org.apache.cayenne.conf.DefaultConfiguration</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.cayenne.conf.FileConfiguration</B>
</PRE>
<DL>
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/cayenne/project/ProjectConfiguration.html" title="class in org.apache.cayenne.project">ProjectConfiguration</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>FileConfiguration</B><DT>extends <A HREF="../../../../org/apache/cayenne/conf/DefaultConfiguration.html" title="class in org.apache.cayenne.conf">DefaultConfiguration</A></DL>
</PRE>
<P>
FileConfiguration loads a Cayenne configuraton file from a given location in the file
system.
<P>
<P>
<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>protected &nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/conf/FileConfiguration.html#projectFile">projectFile</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The domain file used for this configuration</TD>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_org.apache.cayenne.conf.DefaultConfiguration"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from class org.apache.cayenne.conf.<A HREF="../../../../org/apache/cayenne/conf/DefaultConfiguration.html" title="class in org.apache.cayenne.conf">DefaultConfiguration</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/cayenne/conf/DefaultConfiguration.html#locator">locator</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_org.apache.cayenne.conf.Configuration"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from class org.apache.cayenne.conf.<A HREF="../../../../org/apache/cayenne/conf/Configuration.html" title="class in org.apache.cayenne.conf">Configuration</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/cayenne/conf/Configuration.html#configurationShutdownHook">configurationShutdownHook</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#dataDomains">dataDomains</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#dataViewLocations">dataViewLocations</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#DEFAULT_CONFIGURATION_CLASS">DEFAULT_CONFIGURATION_CLASS</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#DEFAULT_DOMAIN_FILE">DEFAULT_DOMAIN_FILE</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#domainConfigurationName">domainConfigurationName</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#eventManager">eventManager</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#ignoringLoadFailures">ignoringLoadFailures</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#loaderDelegate">loaderDelegate</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#loadStatus">loadStatus</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#overrideFactory">overrideFactory</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#overrideStrategy">overrideStrategy</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#projectVersion">projectVersion</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#saverDelegate">saverDelegate</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#sharedConfiguration">sharedConfiguration</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== 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/apache/cayenne/conf/FileConfiguration.html#FileConfiguration()">FileConfiguration</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default constructor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/conf/FileConfiguration.html#FileConfiguration(java.io.File)">FileConfiguration</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>&nbsp;domainConfigurationFile)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a configuration that uses the provided file as the main project file,
ignoring any other lookup strategies.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/conf/FileConfiguration.html#FileConfiguration(java.lang.String)">FileConfiguration</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;domainConfigurationName)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a configuration that uses the provided file name as the main project file,
ignoring any other lookup strategies.</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;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/conf/FileConfiguration.html#addFilesystemPath(java.io.File)">addFilesystemPath</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>&nbsp;path)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds the given directory as a path for filesystem lookups.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/conf/FileConfiguration.html#addFilesystemPath(java.lang.String)">addFilesystemPath</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;path)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds the given String as a custom path for filesystem lookups.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/conf/FileConfiguration.html#canInitialize()">canInitialize</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>since 3.0 - superclass method is deprecated.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/conf/FileConfiguration.html#getProjectDirectory()">getProjectDirectory</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the directory of the current project file as returned by
<A HREF="../../../../org/apache/cayenne/conf/FileConfiguration.html#getProjectFile()"><CODE>getProjectFile()</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/conf/FileConfiguration.html#getProjectFile()">getProjectFile</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the main domain file used for this configuration.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/conf/FileConfiguration.html#setProjectFile(java.io.File)">setProjectFile</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>&nbsp;projectFile)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the main domain file used for this configuration.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.cayenne.conf.DefaultConfiguration"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class org.apache.cayenne.conf.<A HREF="../../../../org/apache/cayenne/conf/DefaultConfiguration.html" title="class in org.apache.cayenne.conf">DefaultConfiguration</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/cayenne/conf/DefaultConfiguration.html#addClassPath(java.lang.String)">addClassPath</A>, <A HREF="../../../../org/apache/cayenne/conf/DefaultConfiguration.html#addResourcePath(java.lang.String)">addResourcePath</A>, <A HREF="../../../../org/apache/cayenne/conf/DefaultConfiguration.html#getDomainConfiguration()">getDomainConfiguration</A>, <A HREF="../../../../org/apache/cayenne/conf/DefaultConfiguration.html#getResourceFinder()">getResourceFinder</A>, <A HREF="../../../../org/apache/cayenne/conf/DefaultConfiguration.html#getResourceLocator()">getResourceLocator</A>, <A HREF="../../../../org/apache/cayenne/conf/DefaultConfiguration.html#initialize()">initialize</A>, <A HREF="../../../../org/apache/cayenne/conf/DefaultConfiguration.html#setResourceLocator(org.apache.cayenne.util.ResourceLocator)">setResourceLocator</A>, <A HREF="../../../../org/apache/cayenne/conf/DefaultConfiguration.html#toString()">toString</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_org.apache.cayenne.conf.Configuration"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class org.apache.cayenne.conf.<A HREF="../../../../org/apache/cayenne/conf/Configuration.html" title="class in org.apache.cayenne.conf">Configuration</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../org/apache/cayenne/conf/Configuration.html#addDomain(org.apache.cayenne.access.DataDomain)">addDomain</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#didInitialize()">didInitialize</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#getDataSourceFactory()">getDataSourceFactory</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#getDataSourceFactory(java.lang.String)">getDataSourceFactory</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#getDataViewLocations()">getDataViewLocations</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#getDomain()">getDomain</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#getDomain(java.lang.String)">getDomain</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#getDomainConfigurationName()">getDomainConfigurationName</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#getDomains()">getDomains</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#getEventManager()">getEventManager</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#getLoaderDelegate()">getLoaderDelegate</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#getLoadStatus()">getLoadStatus</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#getMapConfiguration(java.lang.String)">getMapConfiguration</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#getProjectVersion()">getProjectVersion</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#getSaverDelegate()">getSaverDelegate</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#getSchemaUpdateStrategy()">getSchemaUpdateStrategy</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#getSharedConfiguration()">getSharedConfiguration</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#getViewConfiguration(java.lang.String)">getViewConfiguration</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#initializeSharedConfiguration()">initializeSharedConfiguration</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#initializeSharedConfiguration(java.lang.Class)">initializeSharedConfiguration</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#initializeSharedConfiguration(org.apache.cayenne.conf.Configuration)">initializeSharedConfiguration</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#installConfigurationShutdownHook()">installConfigurationShutdownHook</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#isIgnoringLoadFailures()">isIgnoringLoadFailures</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#removeDomain(java.lang.String)">removeDomain</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#setDataSourceFactory(org.apache.cayenne.conf.DataSourceFactory)">setDataSourceFactory</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#setDataViewLocations(java.util.Map)">setDataViewLocations</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#setDomainConfigurationName(java.lang.String)">setDomainConfigurationName</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#setEventManager(org.apache.cayenne.event.EventManager)">setEventManager</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#setIgnoringLoadFailures(boolean)">setIgnoringLoadFailures</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#setLoaderDelegate(org.apache.cayenne.conf.ConfigLoaderDelegate)">setLoaderDelegate</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#setLoadStatus(org.apache.cayenne.conf.ConfigStatus)">setLoadStatus</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#setProjectVersion(java.lang.String)">setProjectVersion</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#setSaverDelegate(org.apache.cayenne.conf.ConfigSaverDelegate)">setSaverDelegate</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#setSchemaUpdateStrategy(org.apache.cayenne.access.dbsync.SchemaUpdateStrategy)">setSchemaUpdateStrategy</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#shutdown()">shutdown</A>, <A HREF="../../../../org/apache/cayenne/conf/Configuration.html#uninstallConfigurationShutdownHook()">uninstallConfigurationShutdownHook</A></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"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<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="projectFile"><!-- --></A><H3>
projectFile</H3>
<PRE>
protected <A HREF="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> <B>projectFile</B></PRE>
<DL>
<DD>The domain file used for this configuration
<P>
<DL>
</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="FileConfiguration()"><!-- --></A><H3>
FileConfiguration</H3>
<PRE>
public <B>FileConfiguration</B>()</PRE>
<DL>
<DD>Default constructor. Simply calls
<A HREF="../../../../org/apache/cayenne/conf/FileConfiguration.html#FileConfiguration(java.lang.String)"><CODE>FileConfiguration(String)</CODE></A> with
<A HREF="../../../../org/apache/cayenne/conf/Configuration.html#DEFAULT_DOMAIN_FILE"><CODE>Configuration.DEFAULT_DOMAIN_FILE</CODE></A> as argument.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/cayenne/conf/DefaultConfiguration.html#DefaultConfiguration()"><CODE>DefaultConfiguration.DefaultConfiguration()</CODE></A></DL>
</DL>
<HR>
<A NAME="FileConfiguration(java.lang.String)"><!-- --></A><H3>
FileConfiguration</H3>
<PRE>
public <B>FileConfiguration</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;domainConfigurationName)</PRE>
<DL>
<DD>Creates a configuration that uses the provided file name as the main project file,
ignoring any other lookup strategies. The file name is <b>not</b> checked for
existence and must not contain relative or absolute paths, i.e. only the file name.
<P>
<DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/apache/cayenne/ConfigurationException.html" title="class in org.apache.cayenne">ConfigurationException</A></CODE> - when projectFile is <code>null</code>.<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/cayenne/conf/DefaultConfiguration.html#DefaultConfiguration(java.lang.String)"><CODE>DefaultConfiguration.DefaultConfiguration(String)</CODE></A></DL>
</DL>
<HR>
<A NAME="FileConfiguration(java.io.File)"><!-- --></A><H3>
FileConfiguration</H3>
<PRE>
public <B>FileConfiguration</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>&nbsp;domainConfigurationFile)</PRE>
<DL>
<DD>Creates a configuration that uses the provided file as the main project file,
ignoring any other lookup strategies.
<P>
<DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/apache/cayenne/ConfigurationException.html" title="class in org.apache.cayenne">ConfigurationException</A></CODE> - when projectFile is <code>null</code>, a
directory or not readable.</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="addFilesystemPath(java.lang.String)"><!-- --></A><H3>
addFilesystemPath</H3>
<PRE>
public void <B>addFilesystemPath</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;path)</PRE>
<DL>
<DD>Adds the given String as a custom path for filesystem lookups. The path can be
relative or absolute and is <i>not</i> checked for existence. This allows for easy
customization of resource search paths after Constructor invocation:
<pre>
conf = new FileConfiguration(&quot;myconfig-cayenne.xml&quot;);
conf.addFilesystemPath(new File(&quot;a/relative/path&quot;));
conf.addFilesystemPath(new File(&quot;/an/absolute/search/path&quot;));
Configuration.initializeSharedConfiguration(conf);
</pre>
Alternatively use <A HREF="../../../../org/apache/cayenne/conf/FileConfiguration.html#addFilesystemPath(java.io.File)"><CODE>addFilesystemPath(File)</CODE></A> for adding a
path that is checked for existence.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if <code>path</code> is <code>null</code>.</DL>
</DD>
</DL>
<HR>
<A NAME="addFilesystemPath(java.io.File)"><!-- --></A><H3>
addFilesystemPath</H3>
<PRE>
public void <B>addFilesystemPath</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>&nbsp;path)</PRE>
<DL>
<DD>Adds the given directory as a path for filesystem lookups. The directory is checked
for existence.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if <code>path</code> is <code>null</code>,
not a directory or not readable.</DL>
</DD>
</DL>
<HR>
<A NAME="canInitialize()"><!-- --></A><H3>
canInitialize</H3>
<PRE>
public boolean <B>canInitialize</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>since 3.0 - superclass method is deprecated.</I>
<P>
<DD>Only returns <code>true</code> when <A HREF="../../../../org/apache/cayenne/conf/FileConfiguration.html#getProjectFile()"><CODE>getProjectFile()</CODE></A> does not return
<code>null</code>.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../org/apache/cayenne/conf/Configuration.html#canInitialize()">canInitialize</A></CODE> in class <CODE><A HREF="../../../../org/apache/cayenne/conf/Configuration.html" title="class in org.apache.cayenne.conf">Configuration</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getProjectFile()"><!-- --></A><H3>
getProjectFile</H3>
<PRE>
public <A HREF="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> <B>getProjectFile</B>()</PRE>
<DL>
<DD>Returns the main domain file used for this configuration.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="setProjectFile(java.io.File)"><!-- --></A><H3>
setProjectFile</H3>
<PRE>
protected void <B>setProjectFile</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>&nbsp;projectFile)</PRE>
<DL>
<DD>Sets the main domain file used for this configuration.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/apache/cayenne/ConfigurationException.html" title="class in org.apache.cayenne">ConfigurationException</A></CODE> - if <code>projectFile</code> is null, a directory
or not readable.</DL>
</DD>
</DL>
<HR>
<A NAME="getProjectDirectory()"><!-- --></A><H3>
getProjectDirectory</H3>
<PRE>
public <A HREF="http://java.sun.com/javase/6/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> <B>getProjectDirectory</B>()</PRE>
<DL>
<DD>Returns the directory of the current project file as returned by
<A HREF="../../../../org/apache/cayenne/conf/FileConfiguration.html#getProjectFile()"><CODE>getProjectFile()</CODE></A>.
<P>
<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>&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/FileConfiguration.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-all.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;<A HREF="../../../../org/apache/cayenne/conf/DriverDataSourceFactory.html" title="class in org.apache.cayenne.conf"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/cayenne/conf/JNDIDataSourceFactory.html" title="class in org.apache.cayenne.conf"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/cayenne/conf/FileConfiguration.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="FileConfiguration.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;<A HREF="#field_summary">FIELD</A>&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;<A HREF="#field_detail">FIELD</A>&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>
Copyright &#169; 2001-2011 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All Rights Reserved.
</BODY>
</HTML>