| <!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:55 EDT 2006 --> |
| <TITLE> |
| org.objectstyle.cayenne.project (Cayenne API Documentation - v.1.2) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.objectstyle.cayenne.project package"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="org.objectstyle.cayenne.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="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</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/map/event/package-summary.html"><B>PREV PACKAGE</B></A> |
| <A HREF="../../../../org/objectstyle/cayenne/project/validator/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/objectstyle/cayenne/project/package-summary.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="package-summary.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> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <H2> |
| Package org.objectstyle.cayenne.project |
| </H2> |
| Contains model classes used by CayenneModeler or any other |
| MVC type of application to work with Cayenne project files. |
| <P> |
| <B>See:</B> |
| <BR> |
| <A HREF="#package_description"><B>Description</B></A> |
| <P> |
| |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Interface Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/objectstyle/cayenne/project/ProjectTraversalHandler.html" title="interface in org.objectstyle.cayenne.project">ProjectTraversalHandler</A></B></TD> |
| <TD>ProjectTraversalHandler defines callback methods that are |
| invoked during project tree traversal.</TD> |
| </TR> |
| </TABLE> |
| |
| |
| <P> |
| |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Class Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/objectstyle/cayenne/project/ApplicationProject.html" title="class in org.objectstyle.cayenne.project">ApplicationProject</A></B></TD> |
| <TD>Represents Cayenne application project.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/objectstyle/cayenne/project/ApplicationProjectFile.html" title="class in org.objectstyle.cayenne.project">ApplicationProjectFile</A></B></TD> |
| <TD>ApplicationProjectFile is a ProjectFile abstraction of the main project file in a |
| Cayenne project.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/objectstyle/cayenne/project/CayenneUserDir.html" title="class in org.objectstyle.cayenne.project">CayenneUserDir</A></B></TD> |
| <TD>CayenneUserDir represents a directory where all Cayenne-related information |
| is stored on the user machine.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/objectstyle/cayenne/project/DataMapFile.html" title="class in org.objectstyle.cayenne.project">DataMapFile</A></B></TD> |
| <TD>DataMapFile is a ProjectFile abstraction of the |
| DataMap file in a Cayenne project.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/objectstyle/cayenne/project/DataMapProject.html" title="class in org.objectstyle.cayenne.project">DataMapProject</A></B></TD> |
| <TD>Cayenne project that consists of a single DataMap.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/objectstyle/cayenne/project/DataNodeConfigInfo.html" title="class in org.objectstyle.cayenne.project">DataNodeConfigInfo</A></B></TD> |
| <TD>Stores information necessary to reconfigure nodes of existing projects.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/objectstyle/cayenne/project/DataNodeFile.html" title="class in org.objectstyle.cayenne.project">DataNodeFile</A></B></TD> |
| <TD>DataNodeFile is a ProjectFile abstraction of the |
| DataNode file in a Cayenne project.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/objectstyle/cayenne/project/FlatProjectView.html" title="class in org.objectstyle.cayenne.project">FlatProjectView</A></B></TD> |
| <TD>FlatProjectView converts a project tree into a list of nodes, |
| thus flattening the tree.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/objectstyle/cayenne/project/NamedObjectFactory.html" title="class in org.objectstyle.cayenne.project">NamedObjectFactory</A></B></TD> |
| <TD>Factory class that generates various Cayenne objects with |
| default names that are unique in their corresponding context.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/objectstyle/cayenne/project/PartialProject.html" title="class in org.objectstyle.cayenne.project">PartialProject</A></B></TD> |
| <TD>PartialProject is a "lightweight" project implementation.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/objectstyle/cayenne/project/Project.html" title="class in org.objectstyle.cayenne.project">Project</A></B></TD> |
| <TD>Describes a model of Cayenne project.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/objectstyle/cayenne/project/ProjectConfigInfo.html" title="class in org.objectstyle.cayenne.project">ProjectConfigInfo</A></B></TD> |
| <TD>Stores project information necessary to reconfigure existing projects.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/objectstyle/cayenne/project/ProjectConfiguration.html" title="class in org.objectstyle.cayenne.project">ProjectConfiguration</A></B></TD> |
| <TD>Subclass of FileConfiguration used in the project model.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/objectstyle/cayenne/project/ProjectConfigurator.html" title="class in org.objectstyle.cayenne.project">ProjectConfigurator</A></B></TD> |
| <TD>Performs on the fly reconfiguration of Cayenne projects.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/objectstyle/cayenne/project/ProjectDataSource.html" title="class in org.objectstyle.cayenne.project">ProjectDataSource</A></B></TD> |
| <TD>ProjectDataSource is a DataSource implementation used by the project model.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/objectstyle/cayenne/project/ProjectDataSourceFactory.html" title="class in org.objectstyle.cayenne.project">ProjectDataSourceFactory</A></B></TD> |
| <TD>Factory of DataSource objects used by the project model.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/objectstyle/cayenne/project/ProjectFile.html" title="class in org.objectstyle.cayenne.project">ProjectFile</A></B></TD> |
| <TD>ProjectFile is an adapter from an object in Cayenne project |
| to its representation in the file system.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/objectstyle/cayenne/project/ProjectPath.html" title="class in org.objectstyle.cayenne.project">ProjectPath</A></B></TD> |
| <TD>Immutable holder of a selection path within a Cayenne project.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/objectstyle/cayenne/project/ProjectTraversal.html" title="class in org.objectstyle.cayenne.project">ProjectTraversal</A></B></TD> |
| <TD>ProjectTraversal allows to traverse Cayenne project tree in a "depth-first" order |
| starting from an arbitrary level to its children.</TD> |
| </TR> |
| </TABLE> |
| |
| |
| <P> |
| |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Exception Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD WIDTH="15%"><B><A HREF="../../../../org/objectstyle/cayenne/project/ProjectException.html" title="class in org.objectstyle.cayenne.project">ProjectException</A></B></TD> |
| <TD>Runtime exception thrown on various errors within project model.</TD> |
| </TR> |
| </TABLE> |
| |
| |
| <P> |
| <A NAME="package_description"><!-- --></A><H2> |
| Package org.objectstyle.cayenne.project Description |
| </H2> |
| |
| <P> |
| Contains model classes used by CayenneModeler or any other |
| MVC type of application to work with Cayenne project files. Like |
| any good model in MVC, it is independent from a specific GUI layer. |
| |
| <p><code>org.objectstyle.cayenne.project</code> package views the objects that |
| comprise project tree from the point of <strong>semantics</strong> |
| rather than logical relationships. It is normally not used in deployment.</p> |
| |
| <p><code>org.objectstyle.cayenne.project</code> package provides safe implementations of |
| read/write operations on Cayenne project and handles validation, using validators |
| from <code>org.objectstyle.cayenne.project.validator</code> package. |
| <P> |
| |
| <P> |
| <DL> |
| </DL> |
| <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="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</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/map/event/package-summary.html"><B>PREV PACKAGE</B></A> |
| <A HREF="../../../../org/objectstyle/cayenne/project/validator/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/objectstyle/cayenne/project/package-summary.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="package-summary.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> |
| </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> |
