| <!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:45:51 EDT 2006 --> |
| <TITLE> |
| ProjectFile (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.cayenne.project.ProjectFile class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../apache-javadoc.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="ProjectFile (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT)"; |
| } |
| </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/apache/cayenne/project/ProjectException.html" title="class in org.apache.cayenne.project"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/project/ProjectPath.html" title="class in org.apache.cayenne.project"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/cayenne/project/ProjectFile.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ProjectFile.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.apache.cayenne.project</FONT> |
| <BR> |
| Class ProjectFile</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.cayenne.project.ProjectFile</B> |
| </PRE> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/cayenne/project/ApplicationProjectFile.html" title="class in org.apache.cayenne.project">ApplicationProjectFile</A>, <A HREF="../../../../org/apache/cayenne/project/DataMapFile.html" title="class in org.apache.cayenne.project">DataMapFile</A>, <A HREF="../../../../org/apache/cayenne/project/DataNodeFile.html" title="class in org.apache.cayenne.project">DataNodeFile</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public abstract class <B>ProjectFile</B><DT>extends java.lang.Object</DL> |
| </PRE> |
| |
| <P> |
| ProjectFile is an adapter from an object in Cayenne project |
| to its representation in the file system. |
| <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>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/project/ProjectFile.html#location">location</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/apache/cayenne/project/Project.html" title="class in org.apache.cayenne.project">Project</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/project/ProjectFile.html#projectObj">projectObj</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/apache/cayenne/project/ProjectFile.html#tempFile">tempFile</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><CODE><B><A HREF="../../../../org/apache/cayenne/project/ProjectFile.html#ProjectFile()">ProjectFile</A></B>()</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/project/ProjectFile.html#ProjectFile(org.apache.cayenne.project.Project, java.lang.String)">ProjectFile</A></B>(<A HREF="../../../../org/apache/cayenne/project/Project.html" title="class in org.apache.cayenne.project">Project</A> project, |
| java.lang.String location)</CODE> |
| |
| <BR> |
| Constructor for ProjectFile.</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>abstract boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/project/ProjectFile.html#canHandle(java.lang.Object)">canHandle</A></B>(java.lang.Object obj)</CODE> |
| |
| <BR> |
| Returns true if this file wrapper can handle a |
| specified object.</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/apache/cayenne/project/ProjectFile.html#canHandleObject()">canHandleObject</A></B>()</CODE> |
| |
| <BR> |
| Returns true if this file wrapper can handle an |
| internally stored object.</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/apache/cayenne/project/ProjectFile.html#checkWritePermissions(java.io.File)">checkWritePermissions</A></B>(java.io.File file)</CODE> |
| |
| <BR> |
| </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/apache/cayenne/project/ProjectFile.html#getLocation()">getLocation</A></B>()</CODE> |
| |
| <BR> |
| Builds a filename from the object name and "file suffix".</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/apache/cayenne/project/ProjectFile.html#getLocationSuffix()">getLocationSuffix</A></B>()</CODE> |
| |
| <BR> |
| Returns suffix to append to object name when |
| creating a file name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/project/ProjectFile.html#getObject()">getObject</A></B>()</CODE> |
| |
| <BR> |
| Returns a project object associated with this file.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>abstract java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/project/ProjectFile.html#getObjectName()">getObjectName</A></B>()</CODE> |
| |
| <BR> |
| Returns a name of associated object, that is also |
| used as a file 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/apache/cayenne/project/ProjectFile.html#getOldLocation()">getOldLocation</A></B>()</CODE> |
| |
| <BR> |
| Returns saved location of a file.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/apache/cayenne/project/Project.html" title="class in org.apache.cayenne.project">Project</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/project/ProjectFile.html#getProject()">getProject</A></B>()</CODE> |
| |
| <BR> |
| Returns the 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/apache/cayenne/project/ProjectFile.html#isRenamed()">isRenamed</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/apache/cayenne/project/ProjectFile.html#resolveFile()">resolveFile</A></B>()</CODE> |
| |
| <BR> |
| Returns a file which is a canonical representation of the |
| file to store a wrapped object.</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/apache/cayenne/project/ProjectFile.html#resolveOldFile()">resolveOldFile</A></B>()</CODE> |
| |
| <BR> |
| Returns a file which is a canonical representation of the |
| file to store a wrapped object.</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/apache/cayenne/project/ProjectFile.html#save(java.io.PrintWriter)">save</A></B>(java.io.PrintWriter out)</CODE> |
| |
| <BR> |
| Saves an underlying object to the file.</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/apache/cayenne/project/ProjectFile.html#saveCommit()">saveCommit</A></B>()</CODE> |
| |
| <BR> |
| Finishes saving the underlying 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/apache/cayenne/project/ProjectFile.html#saveTemp()">saveTemp</A></B>()</CODE> |
| |
| <BR> |
| Saves ProjectFile's underlying object to a temporary |
| file, returning this file to the caller.</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/apache/cayenne/project/ProjectFile.html#saveUndo()">saveUndo</A></B>()</CODE> |
| |
| <BR> |
| Cleans up after unsuccessful or canceled save attempt.</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/apache/cayenne/project/ProjectFile.html#synchronizeLocation()">synchronizeLocation</A></B>()</CODE> |
| |
| <BR> |
| Replaces internally stored filename with the current object name.</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/apache/cayenne/project/ProjectFile.html#tempFileForFile(java.io.File)">tempFileForFile</A></B>(java.io.File f)</CODE> |
| |
| <BR> |
| Creates a temporary file for the master file.</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/apache/cayenne/project/ProjectFile.html#toString()">toString</A></B>()</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/apache/cayenne/project/ProjectFile.html#willSave()">willSave</A></B>()</CODE> |
| |
| <BR> |
| This method is called by project to let file know that |
| it will be saved.</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, 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="location"><!-- --></A><H3> |
| location</H3> |
| <PRE> |
| protected java.lang.String <B>location</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="tempFile"><!-- --></A><H3> |
| tempFile</H3> |
| <PRE> |
| protected java.io.File <B>tempFile</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="projectObj"><!-- --></A><H3> |
| projectObj</H3> |
| <PRE> |
| protected <A HREF="../../../../org/apache/cayenne/project/Project.html" title="class in org.apache.cayenne.project">Project</A> <B>projectObj</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="ProjectFile()"><!-- --></A><H3> |
| ProjectFile</H3> |
| <PRE> |
| public <B>ProjectFile</B>()</PRE> |
| <DL> |
| </DL> |
| <HR> |
| |
| <A NAME="ProjectFile(org.apache.cayenne.project.Project, java.lang.String)"><!-- --></A><H3> |
| ProjectFile</H3> |
| <PRE> |
| public <B>ProjectFile</B>(<A HREF="../../../../org/apache/cayenne/project/Project.html" title="class in org.apache.cayenne.project">Project</A> project, |
| java.lang.String location)</PRE> |
| <DL> |
| <DD>Constructor for ProjectFile. |
| <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="getLocation()"><!-- --></A><H3> |
| getLocation</H3> |
| <PRE> |
| public java.lang.String <B>getLocation</B>()</PRE> |
| <DL> |
| <DD>Builds a filename from the object name and "file suffix". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOldLocation()"><!-- --></A><H3> |
| getOldLocation</H3> |
| <PRE> |
| public java.lang.String <B>getOldLocation</B>()</PRE> |
| <DL> |
| <DD>Returns saved location of a file. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLocationSuffix()"><!-- --></A><H3> |
| getLocationSuffix</H3> |
| <PRE> |
| public java.lang.String <B>getLocationSuffix</B>()</PRE> |
| <DL> |
| <DD>Returns suffix to append to object name when |
| creating a file name. Default implementation |
| returns empty string. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getObject()"><!-- --></A><H3> |
| getObject</H3> |
| <PRE> |
| public abstract java.lang.Object <B>getObject</B>()</PRE> |
| <DL> |
| <DD>Returns a project object associated with this file. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getObjectName()"><!-- --></A><H3> |
| getObjectName</H3> |
| <PRE> |
| public abstract java.lang.String <B>getObjectName</B>()</PRE> |
| <DL> |
| <DD>Returns a name of associated object, that is also |
| used as a file name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="save(java.io.PrintWriter)"><!-- --></A><H3> |
| save</H3> |
| <PRE> |
| public abstract void <B>save</B>(java.io.PrintWriter out) |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>Saves an underlying object to the file. |
| The procedure is dependent on the type of |
| object and is implemented by concrete subclasses. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="canHandle(java.lang.Object)"><!-- --></A><H3> |
| canHandle</H3> |
| <PRE> |
| public abstract boolean <B>canHandle</B>(java.lang.Object obj)</PRE> |
| <DL> |
| <DD>Returns true if this file wrapper can handle a |
| specified object. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="canHandleObject()"><!-- --></A><H3> |
| canHandleObject</H3> |
| <PRE> |
| public boolean <B>canHandleObject</B>()</PRE> |
| <DL> |
| <DD>Returns true if this file wrapper can handle an |
| internally stored object. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="synchronizeLocation()"><!-- --></A><H3> |
| synchronizeLocation</H3> |
| <PRE> |
| public void <B>synchronizeLocation</B>()</PRE> |
| <DL> |
| <DD>Replaces internally stored filename with the current object name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="willSave()"><!-- --></A><H3> |
| willSave</H3> |
| <PRE> |
| public void <B>willSave</B>()</PRE> |
| <DL> |
| <DD>This method is called by project to let file know that |
| it will be saved. Default implementation is a noop. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="saveTemp()"><!-- --></A><H3> |
| saveTemp</H3> |
| <PRE> |
| public void <B>saveTemp</B>() |
| throws java.lang.Exception</PRE> |
| <DL> |
| <DD>Saves ProjectFile's underlying object to a temporary |
| file, returning this file to the caller. If any problems are |
| encountered during saving, an Exception is thrown. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.Exception</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="resolveFile()"><!-- --></A><H3> |
| resolveFile</H3> |
| <PRE> |
| public java.io.File <B>resolveFile</B>()</PRE> |
| <DL> |
| <DD>Returns a file which is a canonical representation of the |
| file to store a wrapped object. If an object was renamed, |
| the <b>new</b> name is returned. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="resolveOldFile()"><!-- --></A><H3> |
| resolveOldFile</H3> |
| <PRE> |
| public java.io.File <B>resolveOldFile</B>()</PRE> |
| <DL> |
| <DD>Returns a file which is a canonical representation of the |
| file to store a wrapped object. If an object was renamed, |
| the <b>old</b> name is returned. Returns null if this file |
| has never been saved before. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="saveCommit()"><!-- --></A><H3> |
| saveCommit</H3> |
| <PRE> |
| public java.io.File <B>saveCommit</B>() |
| throws <A HREF="../../../../org/apache/cayenne/project/ProjectException.html" title="class in org.apache.cayenne.project">ProjectException</A></PRE> |
| <DL> |
| <DD>Finishes saving the underlying object. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/cayenne/project/ProjectException.html" title="class in org.apache.cayenne.project">ProjectException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="saveUndo()"><!-- --></A><H3> |
| saveUndo</H3> |
| <PRE> |
| public void <B>saveUndo</B>()</PRE> |
| <DL> |
| <DD>Cleans up after unsuccessful or canceled save attempt. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getProject()"><!-- --></A><H3> |
| getProject</H3> |
| <PRE> |
| public <A HREF="../../../../org/apache/cayenne/project/Project.html" title="class in org.apache.cayenne.project">Project</A> <B>getProject</B>()</PRE> |
| <DL> |
| <DD>Returns the project. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>Project</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isRenamed()"><!-- --></A><H3> |
| isRenamed</H3> |
| <PRE> |
| public boolean <B>isRenamed</B>()</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="tempFileForFile(java.io.File)"><!-- --></A><H3> |
| tempFileForFile</H3> |
| <PRE> |
| protected java.io.File <B>tempFileForFile</B>(java.io.File f) |
| throws java.io.IOException</PRE> |
| <DL> |
| <DD>Creates a temporary file for the master file. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.io.IOException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="checkWritePermissions(java.io.File)"><!-- --></A><H3> |
| checkWritePermissions</H3> |
| <PRE> |
| protected void <B>checkWritePermissions</B>(java.io.File file) |
| throws java.io.IOException</PRE> |
| <DL> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.io.IOException</CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="toString()"><!-- --></A><H3> |
| toString</H3> |
| <PRE> |
| public java.lang.String <B>toString</B>()</PRE> |
| <DL> |
| <DD><DL> |
| <DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL> |
| </DD> |
| <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/apache/cayenne/project/ProjectException.html" title="class in org.apache.cayenne.project"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/project/ProjectPath.html" title="class in org.apache.cayenne.project"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/cayenne/project/ProjectFile.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ProjectFile.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> |
| |
| <i>Copyright © 2001-2006 <a href= |
| "http://apache.org" target="_top">Apache.org</a> All Rights Reserved.</i> |
| |
| </BODY> |
| </HTML> |
