| <!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:52 EDT 2006 --> |
| <TITLE> |
| Property (Apache Cayenne API Documentation - v.2.0-incubating-SNAPSHOT) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.apache.cayenne.property.Property interface"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../apache-javadoc.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="Property (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/property/PersistentObjectProperty.html" title="class in org.apache.cayenne.property"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/property/PropertyAccessException.html" title="class in org.apache.cayenne.property"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/cayenne/property/Property.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Property.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <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.property</FONT> |
| <BR> |
| Interface Property</H2> |
| <DL> |
| <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../org/apache/cayenne/property/PropertyAccessor.html" title="interface in org.apache.cayenne.property">PropertyAccessor</A>, java.io.Serializable</DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../org/apache/cayenne/property/ArcProperty.html" title="interface in org.apache.cayenne.property">ArcProperty</A>, <A HREF="../../../../org/apache/cayenne/property/CollectionProperty.html" title="interface in org.apache.cayenne.property">CollectionProperty</A>, <A HREF="../../../../org/apache/cayenne/property/SingleObjectArcProperty.html" title="interface in org.apache.cayenne.property">SingleObjectArcProperty</A></DD> |
| </DL> |
| <DL> |
| <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/cayenne/property/AbstractCollectionProperty.html" title="class in org.apache.cayenne.property">AbstractCollectionProperty</A>, <A HREF="../../../../org/apache/cayenne/property/AbstractSingleObjectArcProperty.html" title="class in org.apache.cayenne.property">AbstractSingleObjectArcProperty</A>, <A HREF="../../../../org/apache/cayenne/property/IndexedListProperty.html" title="class in org.apache.cayenne.property">IndexedListProperty</A>, <A HREF="../../../../org/apache/cayenne/property/ListProperty.html" title="class in org.apache.cayenne.property">ListProperty</A>, <A HREF="../../../../org/apache/cayenne/property/PersistentObjectProperty.html" title="class in org.apache.cayenne.property">PersistentObjectProperty</A>, <A HREF="../../../../org/apache/cayenne/property/SimpleProperty.html" title="class in org.apache.cayenne.property">SimpleProperty</A>, <A HREF="../../../../org/apache/cayenne/property/ToManyListProperty.html" title="class in org.apache.cayenne.property">ToManyListProperty</A>, <A HREF="../../../../org/apache/cayenne/property/ValueHolderProperty.html" title="class in org.apache.cayenne.property">ValueHolderProperty</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>Property</B><DT>extends <A HREF="../../../../org/apache/cayenne/property/PropertyAccessor.html" title="interface in org.apache.cayenne.property">PropertyAccessor</A></DL> |
| </PRE> |
| |
| <P> |
| Defines bean property API used by Cayenne to access object data, do faulting and graph |
| maintenance tasks. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.2</DD> |
| <DT><B>Author:</B></DT> |
| <DD>Andrus Adamchik</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/property/Property.html#injectValueHolder(java.lang.Object)">injectValueHolder</A></B>(java.lang.Object object)</CODE> |
| |
| <BR> |
| If a property is implemented as a ValueHolder, this operation would create an |
| unfaulted value holder and inject it into the object, if an object doesn't have it |
| set yet.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/cayenne/property/Property.html#readProperty(java.lang.Object)">readProperty</A></B>(java.lang.Object object)</CODE> |
| |
| <BR> |
| Returns a property value, resolving object fault if needed.</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/property/Property.html#shallowMerge(java.lang.Object, java.lang.Object)">shallowMerge</A></B>(java.lang.Object from, |
| java.lang.Object to)</CODE> |
| |
| <BR> |
| Copies a property value from one object to another.</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/property/Property.html#visit(org.apache.cayenne.property.PropertyVisitor)">visit</A></B>(<A HREF="../../../../org/apache/cayenne/property/PropertyVisitor.html" title="interface in org.apache.cayenne.property">PropertyVisitor</A> visitor)</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/property/Property.html#writeProperty(java.lang.Object, java.lang.Object, java.lang.Object)">writeProperty</A></B>(java.lang.Object object, |
| java.lang.Object oldValue, |
| java.lang.Object newValue)</CODE> |
| |
| <BR> |
| Sets a property value,resolving object fault if needed.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.apache.cayenne.property.PropertyAccessor"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from interface org.apache.cayenne.property.<A HREF="../../../../org/apache/cayenne/property/PropertyAccessor.html" title="interface in org.apache.cayenne.property">PropertyAccessor</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../org/apache/cayenne/property/PropertyAccessor.html#getName()">getName</A>, <A HREF="../../../../org/apache/cayenne/property/PropertyAccessor.html#readPropertyDirectly(java.lang.Object)">readPropertyDirectly</A>, <A HREF="../../../../org/apache/cayenne/property/PropertyAccessor.html#writePropertyDirectly(java.lang.Object, java.lang.Object, java.lang.Object)">writePropertyDirectly</A></CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ 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="readProperty(java.lang.Object)"><!-- --></A><H3> |
| readProperty</H3> |
| <PRE> |
| java.lang.Object <B>readProperty</B>(java.lang.Object object) |
| throws <A HREF="../../../../org/apache/cayenne/property/PropertyAccessException.html" title="class in org.apache.cayenne.property">PropertyAccessException</A></PRE> |
| <DL> |
| <DD>Returns a property value, resolving object fault if needed. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/cayenne/property/PropertyAccessException.html" title="class in org.apache.cayenne.property">PropertyAccessException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="writeProperty(java.lang.Object, java.lang.Object, java.lang.Object)"><!-- --></A><H3> |
| writeProperty</H3> |
| <PRE> |
| void <B>writeProperty</B>(java.lang.Object object, |
| java.lang.Object oldValue, |
| java.lang.Object newValue) |
| throws <A HREF="../../../../org/apache/cayenne/property/PropertyAccessException.html" title="class in org.apache.cayenne.property">PropertyAccessException</A></PRE> |
| <DL> |
| <DD>Sets a property value,resolving object fault if needed. Old value of the property |
| is specified as a hint. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/cayenne/property/PropertyAccessException.html" title="class in org.apache.cayenne.property">PropertyAccessException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="visit(org.apache.cayenne.property.PropertyVisitor)"><!-- --></A><H3> |
| visit</H3> |
| <PRE> |
| boolean <B>visit</B>(<A HREF="../../../../org/apache/cayenne/property/PropertyVisitor.html" title="interface in org.apache.cayenne.property">PropertyVisitor</A> visitor)</PRE> |
| <DL> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="injectValueHolder(java.lang.Object)"><!-- --></A><H3> |
| injectValueHolder</H3> |
| <PRE> |
| void <B>injectValueHolder</B>(java.lang.Object object) |
| throws <A HREF="../../../../org/apache/cayenne/property/PropertyAccessException.html" title="class in org.apache.cayenne.property">PropertyAccessException</A></PRE> |
| <DL> |
| <DD>If a property is implemented as a ValueHolder, this operation would create an |
| unfaulted value holder and inject it into the object, if an object doesn't have it |
| set yet. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/cayenne/property/PropertyAccessException.html" title="class in org.apache.cayenne.property">PropertyAccessException</A></CODE></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="shallowMerge(java.lang.Object, java.lang.Object)"><!-- --></A><H3> |
| shallowMerge</H3> |
| <PRE> |
| void <B>shallowMerge</B>(java.lang.Object from, |
| java.lang.Object to) |
| throws <A HREF="../../../../org/apache/cayenne/property/PropertyAccessException.html" title="class in org.apache.cayenne.property">PropertyAccessException</A></PRE> |
| <DL> |
| <DD>Copies a property value from one object to another. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../org/apache/cayenne/property/PropertyAccessException.html" title="class in org.apache.cayenne.property">PropertyAccessException</A></CODE></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/property/PersistentObjectProperty.html" title="class in org.apache.cayenne.property"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/cayenne/property/PropertyAccessException.html" title="class in org.apache.cayenne.property"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/apache/cayenne/property/Property.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Property.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <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> |
