| <!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:50 EDT 2006 --> |
| <TITLE> |
| Project (Cayenne API Documentation - v.1.2) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.objectstyle.cayenne.project.Project class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="Project (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/project/PartialProject.NodeMetaData.html" title="class in org.objectstyle.cayenne.project"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/objectstyle/cayenne/project/ProjectConfigInfo.html" title="class in org.objectstyle.cayenne.project"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/objectstyle/cayenne/project/Project.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Project.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.project</FONT> |
| <BR> |
| Class Project</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.project.Project</B> |
| </PRE> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/objectstyle/cayenne/project/ApplicationProject.html" title="class in org.objectstyle.cayenne.project">ApplicationProject</A>, <A HREF="../../../../org/objectstyle/cayenne/project/DataMapProject.html" title="class in org.objectstyle.cayenne.project">DataMapProject</A>, <A HREF="../../../../org/objectstyle/cayenne/project/PartialProject.html" title="class in org.objectstyle.cayenne.project">PartialProject</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public abstract class <B>Project</B><DT>extends java.lang.Object</DL> |
| </PRE> |
| |
| <P> |
| Describes a model of Cayenne project. Project is a set of files in the filesystem |
| describing storing Cayenne DataMaps, DataNodes and other information. |
| <p> |
| Project has a project directory, which is a canonical directory. All project files are |
| relative to the project directory. |
| </p> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Andrei Adamchik</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 java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/project/Project.html#CURRENT_PROJECT_VERSION">CURRENT_PROJECT_VERSION</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/project/Project.html#files">files</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/project/Project.html#modified">modified</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.io.File</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/project/Project.html#projectDir">projectDir</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/project/Project.html#upgradeMessages">upgradeMessages</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/project/Project.html#Project()">Project</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> </CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/project/Project.html#Project(java.io.File)">Project</A></B>(java.io.File projectFile)</CODE> |
| |
| <BR> |
| Constructor for Project.</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> java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/project/Project.html#buildFileList()">buildFileList</A></B>()</CODE> |
| |
| <BR> |
| Creates a list of project files.</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/project/Project.html#checkForUpgrades()">checkForUpgrades</A></B>()</CODE> |
| |
| <BR> |
| Determines whether the project needs to be upgraded.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../org/objectstyle/cayenne/project/Project.html" title="class in org.objectstyle.cayenne.project">Project</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/project/Project.html#createProject(java.io.File)">createProject</A></B>(java.io.File projectFile)</CODE> |
| |
| <BR> |
| Factory method to create the right project type given project file.</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/project/Project.html#deleteFile(java.io.File)">deleteFile</A></B>(java.io.File f)</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/project/ProjectFile.html" title="class in org.objectstyle.cayenne.project">ProjectFile</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/project/Project.html#findFile(java.lang.Object)">findFile</A></B>(java.lang.Object obj)</CODE> |
| |
| <BR> |
| Looks up and returns a file wrapper for a project object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/project/Project.html#getChildren()">getChildren</A></B>()</CODE> |
| |
| <BR> |
| Returns a list of first-level children of the project.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract <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/project/Project.html#getLoadStatus()">getLoadStatus</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.io.File</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/project/Project.html#getMainFile()">getMainFile</A></B>()</CODE> |
| |
| <BR> |
| Returns a canonical form of a main file associated with this project.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.io.File</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/project/Project.html#getProjectDirectory()">getProjectDirectory</A></B>()</CODE> |
| |
| <BR> |
| Returns project directory.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/project/Project.html#getUpgradeMessages()">getUpgradeMessages</A></B>()</CODE> |
| |
| <BR> |
| Returns a list of upgrade messages.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/objectstyle/cayenne/project/validator/Validator.html" title="class in org.objectstyle.cayenne.project.validator">Validator</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/project/Project.html#getValidator()">getValidator</A></B>()</CODE> |
| |
| <BR> |
| Creates an instance of Validator for validating this project.</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/project/Project.html#hasRenamedFiles()">hasRenamedFiles</A></B>()</CODE> |
| |
| <BR> |
| Returns true is project has renamed files.</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/project/Project.html#initialize(java.io.File)">initialize</A></B>(java.io.File projectFile)</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/project/Project.html#isLocationUndefined()">isLocationUndefined</A></B>()</CODE> |
| |
| <BR> |
| Returns true if project location is not defined.</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/project/Project.html#isModified()">isModified</A></B>()</CODE> |
| |
| <BR> |
| Returns <code>true</code> if the project is modified.</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/project/Project.html#isUpgradeNeeded()">isUpgradeNeeded</A></B>()</CODE> |
| |
| <BR> |
| Returns true if the project needs to be upgraded.</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/project/Project.html#postInitialize(java.io.File)">postInitialize</A></B>(java.io.File projectFile)</CODE> |
| |
| <BR> |
| Finished project initialization.</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/project/Project.html#prepareSave(java.util.List, java.util.List)">prepareSave</A></B>(java.util.List filesToSave, |
| java.util.List wrappedObjects)</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/project/Project.html#processDelete(java.util.List, java.util.List)">processDelete</A></B>(java.util.List existingObjects, |
| java.util.List savedFiles)</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/project/Project.html#processSave(java.util.List)">processSave</A></B>(java.util.List modifiedFiles)</CODE> |
| |
| <BR> |
| Saves a list of modified files to temporary files.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract <A HREF="../../../../org/objectstyle/cayenne/project/ProjectFile.html" title="class in org.objectstyle.cayenne.project">ProjectFile</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/project/Project.html#projectFileForObject(java.lang.Object)">projectFileForObject</A></B>(java.lang.Object obj)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.io.File</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/project/Project.html#resolveFile(java.lang.String)">resolveFile</A></B>(java.lang.String symbolicName)</CODE> |
| |
| <BR> |
| Returns a canonical file built from symbolic name.</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/project/Project.html#resolveSymbolicName(java.io.File)">resolveSymbolicName</A></B>(java.io.File file)</CODE> |
| |
| <BR> |
| Returns a "symbolic" name of a file.</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/project/Project.html#save()">save</A></B>()</CODE> |
| |
| <BR> |
| Saves project.</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/project/Project.html#setModified(boolean)">setModified</A></B>(boolean modified)</CODE> |
| |
| <BR> |
| Updates "modified" state of the project.</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/project/Project.html#setProjectDirectory(java.io.File)">setProjectDirectory</A></B>(java.io.File dir)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Iterator</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/project/Project.html#treeNodes()">treeNodes</A></B>()</CODE> |
| |
| <BR> |
| Returns an Iterator over project tree of objects.</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/project/Project.html#upgrade()">upgrade</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="CURRENT_PROJECT_VERSION"><!-- --></A><H3> |
| CURRENT_PROJECT_VERSION</H3> |
| <PRE> |
| public static final java.lang.String <B>CURRENT_PROJECT_VERSION</B></PRE> |
| <DL> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.objectstyle.cayenne.project.Project.CURRENT_PROJECT_VERSION">Constant Field Values</A></DL> |
| </DL> |
| <HR> |
| |
| <A NAME="projectDir"><!-- --></A><H3> |
| projectDir</H3> |
| <PRE> |
| protected java.io.File <B>projectDir</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="files"><!-- --></A><H3> |
| files</H3> |
| <PRE> |
| protected java.util.List <B>files</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="upgradeMessages"><!-- --></A><H3> |
| upgradeMessages</H3> |
| <PRE> |
| protected java.util.List <B>upgradeMessages</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="modified"><!-- --></A><H3> |
| modified</H3> |
| <PRE> |
| protected boolean <B>modified</B></PRE> |
| <DL> |
| <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="Project()"><!-- --></A><H3> |
| Project</H3> |
| <PRE> |
| protected <B>Project</B>()</PRE> |
| <DL> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="Project(java.io.File)"><!-- --></A><H3> |
| Project</H3> |
| <PRE> |
| public <B>Project</B>(java.io.File projectFile)</PRE> |
| <DL> |
| <DD>Constructor for Project. <code>projectFile</code> must denote a file (existent or |
| non-existent) in an existing directory. If projectFile has no parent directory, |
| current directory is assumed. |
| <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="createProject(java.io.File)"><!-- --></A><H3> |
| createProject</H3> |
| <PRE> |
| public static <A HREF="../../../../org/objectstyle/cayenne/project/Project.html" title="class in org.objectstyle.cayenne.project">Project</A> <B>createProject</B>(java.io.File projectFile)</PRE> |
| <DL> |
| <DD>Factory method to create the right project type given project file. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="initialize(java.io.File)"><!-- --></A><H3> |
| initialize</H3> |
| <PRE> |
| protected void <B>initialize</B>(java.io.File projectFile)</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="postInitialize(java.io.File)"><!-- --></A><H3> |
| postInitialize</H3> |
| <PRE> |
| protected void <B>postInitialize</B>(java.io.File projectFile)</PRE> |
| <DL> |
| <DD>Finished project initialization. Called from constructor. Default implementation |
| builds a file list and checks for upgrades. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isLocationUndefined()"><!-- --></A><H3> |
| isLocationUndefined</H3> |
| <PRE> |
| public boolean <B>isLocationUndefined</B>()</PRE> |
| <DL> |
| <DD>Returns true if project location is not defined. For instance, when project was |
| created in memory and is not tied to a file yet. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isUpgradeNeeded()"><!-- --></A><H3> |
| isUpgradeNeeded</H3> |
| <PRE> |
| public boolean <B>isUpgradeNeeded</B>()</PRE> |
| <DL> |
| <DD>Returns true if the project needs to be upgraded. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getUpgradeMessages()"><!-- --></A><H3> |
| getUpgradeMessages</H3> |
| <PRE> |
| public java.util.List <B>getUpgradeMessages</B>()</PRE> |
| <DL> |
| <DD>Returns a list of upgrade messages. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="hasRenamedFiles()"><!-- --></A><H3> |
| hasRenamedFiles</H3> |
| <PRE> |
| public boolean <B>hasRenamedFiles</B>()</PRE> |
| <DL> |
| <DD>Returns true is project has renamed files. This is useful when converting from |
| older versions of the modeler projects. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="buildFileList()"><!-- --></A><H3> |
| buildFileList</H3> |
| <PRE> |
| public java.util.List <B>buildFileList</B>()</PRE> |
| <DL> |
| <DD>Creates a list of project files. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getValidator()"><!-- --></A><H3> |
| getValidator</H3> |
| <PRE> |
| public <A HREF="../../../../org/objectstyle/cayenne/project/validator/Validator.html" title="class in org.objectstyle.cayenne.project.validator">Validator</A> <B>getValidator</B>()</PRE> |
| <DL> |
| <DD>Creates an instance of Validator for validating this project. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findFile(java.lang.Object)"><!-- --></A><H3> |
| findFile</H3> |
| <PRE> |
| public <A HREF="../../../../org/objectstyle/cayenne/project/ProjectFile.html" title="class in org.objectstyle.cayenne.project">ProjectFile</A> <B>findFile</B>(java.lang.Object obj)</PRE> |
| <DL> |
| <DD>Looks up and returns a file wrapper for a project object. Returns null if no file |
| exists. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="resolveFile(java.lang.String)"><!-- --></A><H3> |
| resolveFile</H3> |
| <PRE> |
| public java.io.File <B>resolveFile</B>(java.lang.String symbolicName)</PRE> |
| <DL> |
| <DD>Returns a canonical file built from symbolic name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="resolveSymbolicName(java.io.File)"><!-- --></A><H3> |
| resolveSymbolicName</H3> |
| <PRE> |
| public java.lang.String <B>resolveSymbolicName</B>(java.io.File file)</PRE> |
| <DL> |
| <DD>Returns a "symbolic" name of a file. Returns null if file is invalid. Symbolic name |
| is a string path of a file relative to the project directory. It is built in a |
| platform independent fashion. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getProjectDirectory()"><!-- --></A><H3> |
| getProjectDirectory</H3> |
| <PRE> |
| public java.io.File <B>getProjectDirectory</B>()</PRE> |
| <DL> |
| <DD>Returns project directory. This is a directory where project file is located. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setProjectDirectory(java.io.File)"><!-- --></A><H3> |
| setProjectDirectory</H3> |
| <PRE> |
| public void <B>setProjectDirectory</B>(java.io.File dir)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getMainFile()"><!-- --></A><H3> |
| getMainFile</H3> |
| <PRE> |
| public java.io.File <B>getMainFile</B>()</PRE> |
| <DL> |
| <DD>Returns a canonical form of a main file associated with this project. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLoadStatus()"><!-- --></A><H3> |
| getLoadStatus</H3> |
| <PRE> |
| public abstract <A HREF="../../../../org/objectstyle/cayenne/conf/ConfigStatus.html" title="class in org.objectstyle.cayenne.conf">ConfigStatus</A> <B>getLoadStatus</B>()</PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>An object describing failures in the loaded project.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="projectFileForObject(java.lang.Object)"><!-- --></A><H3> |
| projectFileForObject</H3> |
| <PRE> |
| public abstract <A HREF="../../../../org/objectstyle/cayenne/project/ProjectFile.html" title="class in org.objectstyle.cayenne.project">ProjectFile</A> <B>projectFileForObject</B>(java.lang.Object obj)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getChildren()"><!-- --></A><H3> |
| getChildren</H3> |
| <PRE> |
| public abstract java.util.List <B>getChildren</B>()</PRE> |
| <DL> |
| <DD>Returns a list of first-level children of the project. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="checkForUpgrades()"><!-- --></A><H3> |
| checkForUpgrades</H3> |
| <PRE> |
| public abstract void <B>checkForUpgrades</B>()</PRE> |
| <DL> |
| <DD>Determines whether the project needs to be upgraded. Populates internal list of |
| upgrade messages with discovered information. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="treeNodes()"><!-- --></A><H3> |
| treeNodes</H3> |
| <PRE> |
| public java.util.Iterator <B>treeNodes</B>()</PRE> |
| <DL> |
| <DD>Returns an Iterator over project tree of objects. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="upgrade()"><!-- --></A><H3> |
| upgrade</H3> |
| <PRE> |
| public abstract void <B>upgrade</B>() |
| throws <A HREF="../../../../org/objectstyle/cayenne/project/ProjectException.html" title="class in org.objectstyle.cayenne.project">ProjectException</A></PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/objectstyle/cayenne/project/ProjectException.html" title="class in org.objectstyle.cayenne.project">ProjectException</A></CODE><DT><B>Since:</B></DT> |
| <DD>1.1</DD> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="save()"><!-- --></A><H3> |
| save</H3> |
| <PRE> |
| public void <B>save</B>() |
| throws <A HREF="../../../../org/objectstyle/cayenne/project/ProjectException.html" title="class in org.objectstyle.cayenne.project">ProjectException</A></PRE> |
| <DL> |
| <DD>Saves project. All currently existing files are updated, without checking for |
| modifications. New files are created as needed, unused files are deleted. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/objectstyle/cayenne/project/ProjectException.html" title="class in org.objectstyle.cayenne.project">ProjectException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="prepareSave(java.util.List, java.util.List)"><!-- --></A><H3> |
| prepareSave</H3> |
| <PRE> |
| protected void <B>prepareSave</B>(java.util.List filesToSave, |
| java.util.List wrappedObjects) |
| throws <A HREF="../../../../org/objectstyle/cayenne/project/ProjectException.html" title="class in org.objectstyle.cayenne.project">ProjectException</A></PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/objectstyle/cayenne/project/ProjectException.html" title="class in org.objectstyle.cayenne.project">ProjectException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="processSave(java.util.List)"><!-- --></A><H3> |
| processSave</H3> |
| <PRE> |
| protected void <B>processSave</B>(java.util.List modifiedFiles) |
| throws <A HREF="../../../../org/objectstyle/cayenne/project/ProjectException.html" title="class in org.objectstyle.cayenne.project">ProjectException</A></PRE> |
| <DL> |
| <DD>Saves a list of modified files to temporary files. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/objectstyle/cayenne/project/ProjectException.html" title="class in org.objectstyle.cayenne.project">ProjectException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="processDelete(java.util.List, java.util.List)"><!-- --></A><H3> |
| processDelete</H3> |
| <PRE> |
| protected void <B>processDelete</B>(java.util.List existingObjects, |
| java.util.List savedFiles)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="deleteFile(java.io.File)"><!-- --></A><H3> |
| deleteFile</H3> |
| <PRE> |
| protected boolean <B>deleteFile</B>(java.io.File f)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isModified()"><!-- --></A><H3> |
| isModified</H3> |
| <PRE> |
| public boolean <B>isModified</B>()</PRE> |
| <DL> |
| <DD>Returns <code>true</code> if the project is modified. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setModified(boolean)"><!-- --></A><H3> |
| setModified</H3> |
| <PRE> |
| public void <B>setModified</B>(boolean modified)</PRE> |
| <DL> |
| <DD>Updates "modified" state of the project. |
| <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> </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/project/PartialProject.NodeMetaData.html" title="class in org.objectstyle.cayenne.project"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/objectstyle/cayenne/project/ProjectConfigInfo.html" title="class in org.objectstyle.cayenne.project"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/objectstyle/cayenne/project/Project.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Project.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> |
