Google Git
Sign in
apache / cayenne-website / 0af753b3ec346c0432aa26fe6065228badfd46ed / . / docs / 3.0 / api / org / apache / cayenne / util / XMLSerializable.html
blob: 3ce2df9542e49fe4584f1ebc1e0b444f63d93a80 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_24) on Sat Jun 11 11:32:47 EEST 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
XMLSerializable (Cayenne Documentation 3.0.2 API)
</TITLE>
<META NAME="date" CONTENT="2011-06-11">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="XMLSerializable (Cayenne Documentation 3.0.2 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XMLSerializable.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/cayenne/util/ZipUtil.html" title="class in org.apache.cayenne.util"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/cayenne/util/XMLSerializable.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="XMLSerializable.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.cayenne.util</FONT>
<BR>
Interface XMLSerializable</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/cayenne/exp/parser/AggregateConditionNode.html" title="class in org.apache.cayenne.exp.parser">AggregateConditionNode</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTAdd.html" title="class in org.apache.cayenne.exp.parser">ASTAdd</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTAnd.html" title="class in org.apache.cayenne.exp.parser">ASTAnd</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTBetween.html" title="class in org.apache.cayenne.exp.parser">ASTBetween</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTDbPath.html" title="class in org.apache.cayenne.exp.parser">ASTDbPath</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTDivide.html" title="class in org.apache.cayenne.exp.parser">ASTDivide</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTEqual.html" title="class in org.apache.cayenne.exp.parser">ASTEqual</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTFalse.html" title="class in org.apache.cayenne.exp.parser">ASTFalse</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTGreater.html" title="class in org.apache.cayenne.exp.parser">ASTGreater</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTGreaterOrEqual.html" title="class in org.apache.cayenne.exp.parser">ASTGreaterOrEqual</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTIn.html" title="class in org.apache.cayenne.exp.parser">ASTIn</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTLess.html" title="class in org.apache.cayenne.exp.parser">ASTLess</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTLessOrEqual.html" title="class in org.apache.cayenne.exp.parser">ASTLessOrEqual</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTLike.html" title="class in org.apache.cayenne.exp.parser">ASTLike</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTLikeIgnoreCase.html" title="class in org.apache.cayenne.exp.parser">ASTLikeIgnoreCase</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTList.html" title="class in org.apache.cayenne.exp.parser">ASTList</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTMultiply.html" title="class in org.apache.cayenne.exp.parser">ASTMultiply</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTNamedParameter.html" title="class in org.apache.cayenne.exp.parser">ASTNamedParameter</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTNegate.html" title="class in org.apache.cayenne.exp.parser">ASTNegate</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTNot.html" title="class in org.apache.cayenne.exp.parser">ASTNot</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTNotBetween.html" title="class in org.apache.cayenne.exp.parser">ASTNotBetween</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTNotEqual.html" title="class in org.apache.cayenne.exp.parser">ASTNotEqual</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTNotIn.html" title="class in org.apache.cayenne.exp.parser">ASTNotIn</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTNotLike.html" title="class in org.apache.cayenne.exp.parser">ASTNotLike</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTNotLikeIgnoreCase.html" title="class in org.apache.cayenne.exp.parser">ASTNotLikeIgnoreCase</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTObjPath.html" title="class in org.apache.cayenne.exp.parser">ASTObjPath</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTOr.html" title="class in org.apache.cayenne.exp.parser">ASTOr</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTPath.html" title="class in org.apache.cayenne.exp.parser">ASTPath</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTScalar.html" title="class in org.apache.cayenne.exp.parser">ASTScalar</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTSubtract.html" title="class in org.apache.cayenne.exp.parser">ASTSubtract</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ASTTrue.html" title="class in org.apache.cayenne.exp.parser">ASTTrue</A>, <A HREF="../../../../org/apache/cayenne/map/Attribute.html" title="class in org.apache.cayenne.map">Attribute</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/ConditionNode.html" title="class in org.apache.cayenne.exp.parser">ConditionNode</A>, <A HREF="../../../../org/apache/cayenne/map/DataMap.html" title="class in org.apache.cayenne.map">DataMap</A>, <A HREF="../../../../org/apache/cayenne/map/DbAttribute.html" title="class in org.apache.cayenne.map">DbAttribute</A>, <A HREF="../../../../org/apache/cayenne/map/DbEntity.html" title="class in org.apache.cayenne.map">DbEntity</A>, <A HREF="../../../../org/apache/cayenne/map/DbJoin.html" title="class in org.apache.cayenne.map">DbJoin</A>, <A HREF="../../../../org/apache/cayenne/map/DbKeyGenerator.html" title="class in org.apache.cayenne.map">DbKeyGenerator</A>, <A HREF="../../../../org/apache/cayenne/map/DbRelationship.html" title="class in org.apache.cayenne.map">DbRelationship</A>, <A HREF="../../../../org/apache/cayenne/map/DbRelationshipDetected.html" title="class in org.apache.cayenne.map">DbRelationshipDetected</A>, <A HREF="../../../../org/apache/cayenne/map/DetectedDbEntity.html" title="class in org.apache.cayenne.map">DetectedDbEntity</A>, <A HREF="../../../../org/apache/cayenne/query/EJBQLQuery.html" title="class in org.apache.cayenne.query">EJBQLQuery</A>, <A HREF="../../../../org/apache/cayenne/map/Embeddable.html" title="class in org.apache.cayenne.map">Embeddable</A>, <A HREF="../../../../org/apache/cayenne/map/EmbeddableAttribute.html" title="class in org.apache.cayenne.map">EmbeddableAttribute</A>, <A HREF="../../../../org/apache/cayenne/map/EmbeddedAttribute.html" title="class in org.apache.cayenne.map">EmbeddedAttribute</A>, <A HREF="../../../../org/apache/cayenne/map/Entity.html" title="class in org.apache.cayenne.map">Entity</A>, <A HREF="../../../../org/apache/cayenne/map/EntityListener.html" title="class in org.apache.cayenne.map">EntityListener</A>, <A HREF="../../../../org/apache/cayenne/wocompat/EODbAttribute.html" title="class in org.apache.cayenne.wocompat">EODbAttribute</A>, <A HREF="../../../../org/apache/cayenne/wocompat/EOObjAttribute.html" title="class in org.apache.cayenne.wocompat">EOObjAttribute</A>, <A HREF="../../../../org/apache/cayenne/wocompat/EOObjEntity.html" title="class in org.apache.cayenne.wocompat">EOObjEntity</A>, <A HREF="../../../../org/apache/cayenne/wocompat/EOQuery.html" title="class in org.apache.cayenne.wocompat">EOQuery</A>, <A HREF="../../../../org/apache/cayenne/wocompat/EOSQLQuery.html" title="class in org.apache.cayenne.wocompat">EOSQLQuery</A>, <A HREF="../../../../org/apache/cayenne/exp/Expression.html" title="class in org.apache.cayenne.exp">Expression</A>, <A HREF="../../../../org/apache/cayenne/map/ObjAttribute.html" title="class in org.apache.cayenne.map">ObjAttribute</A>, <A HREF="../../../../org/apache/cayenne/map/ObjEntity.html" title="class in org.apache.cayenne.map">ObjEntity</A>, <A HREF="../../../../org/apache/cayenne/map/ObjRelationship.html" title="class in org.apache.cayenne.map">ObjRelationship</A>, <A HREF="../../../../org/apache/cayenne/query/Ordering.html" title="class in org.apache.cayenne.query">Ordering</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/PatternMatchNode.html" title="class in org.apache.cayenne.exp.parser">PatternMatchNode</A>, <A HREF="../../../../org/apache/cayenne/query/PrefetchSelectQuery.html" title="class in org.apache.cayenne.query">PrefetchSelectQuery</A>, <A HREF="../../../../org/apache/cayenne/query/PrefetchTreeNode.html" title="class in org.apache.cayenne.query">PrefetchTreeNode</A>, <A HREF="../../../../org/apache/cayenne/map/Procedure.html" title="class in org.apache.cayenne.map">Procedure</A>, <A HREF="../../../../org/apache/cayenne/map/ProcedureParameter.html" title="class in org.apache.cayenne.map">ProcedureParameter</A>, <A HREF="../../../../org/apache/cayenne/query/ProcedureQuery.html" title="class in org.apache.cayenne.query">ProcedureQuery</A>, <A HREF="../../../../org/apache/cayenne/map/Relationship.html" title="class in org.apache.cayenne.map">Relationship</A>, <A HREF="../../../../org/apache/cayenne/query/SelectQuery.html" title="class in org.apache.cayenne.query">SelectQuery</A>, <A HREF="../../../../org/apache/cayenne/exp/parser/SimpleNode.html" title="class in org.apache.cayenne.exp.parser">SimpleNode</A>, <A HREF="../../../../org/apache/cayenne/query/SQLTemplate.html" title="class in org.apache.cayenne.query">SQLTemplate</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>XMLSerializable</B></DL>
</PRE>
<P>
Interface for Cayenne objects that can be saved to XML.
<P>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.1</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>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/cayenne/util/XMLSerializable.html#encodeAsXML(org.apache.cayenne.util.XMLEncoder)">encodeAsXML</A></B>(<A HREF="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</A>&nbsp;encoder)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Prints itself as XML to the provided XMLEncoder.</TD>
</TR>
</TABLE>
&nbsp;
<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="encodeAsXML(org.apache.cayenne.util.XMLEncoder)"><!-- --></A><H3>
encodeAsXML</H3>
<PRE>
void <B>encodeAsXML</B>(<A HREF="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util">XMLEncoder</A>&nbsp;encoder)</PRE>
<DL>
<DD>Prints itself as XML to the provided XMLEncoder.
<P>
<DD><DL>
<DT><B>Since:</B></DT>
<DD>1.1</DD>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/XMLSerializable.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/cayenne/util/XMLEncoder.html" title="class in org.apache.cayenne.util"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/cayenne/util/ZipUtil.html" title="class in org.apache.cayenne.util"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/cayenne/util/XMLSerializable.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="XMLSerializable.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2001-2011 <a href="http://cayenne.apache.org/">Apache Cayenne</a>. All Rights Reserved.
</BODY>
</HTML>