You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@abdera.apache.org by jm...@apache.org on 2006/06/16 23:25:34 UTC
svn commit: r414919 [3/18] - in /incubator/abdera/site/trunk/docs/api: ./
org/ org/apache/ org/apache/abdera/ org/apache/abdera/factory/
org/apache/abdera/filter/ org/apache/abdera/model/
org/apache/abdera/parser/ org/apache/abdera/xpath/ resources/
Added: incubator/abdera/site/trunk/docs/api/index.html
URL: http://svn.apache.org/viewvc/incubator/abdera/site/trunk/docs/api/index.html?rev=414919&view=auto
==============================================================================
--- incubator/abdera/site/trunk/docs/api/index.html (added)
+++ incubator/abdera/site/trunk/docs/api/index.html Fri Jun 16 14:25:31 2006
@@ -0,0 +1,37 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc on Fri Jun 16 14:22:54 PDT 2006-->
+<TITLE>
+Abdera
+</TITLE>
+<SCRIPT type="text/javascript">
+ targetPage = "" + window.location.search;
+ if (targetPage != "" && targetPage != "undefined")
+ targetPage = targetPage.substring(1);
+ function loadFrames() {
+ if (targetPage != "" && targetPage != "undefined")
+ top.classFrame.location = top.targetPage;
+ }
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+</HEAD>
+<FRAMESET cols="20%,80%" title="" onLoad="top.loadFrames()">
+<FRAMESET rows="30%,70%" title="" onLoad="top.loadFrames()">
+<FRAME src="overview-frame.html" name="packageListFrame" title="All Packages">
+<FRAME src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces (except non-static nested types)">
+</FRAMESET>
+<FRAME src="overview-summary.html" name="classFrame" title="Package, class and interface descriptions" scrolling="yes">
+<NOFRAMES>
+<H2>
+Frame Alert</H2>
+
+<P>
+This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client.
+<BR>
+Link to<A HREF="overview-summary.html">Non-frame version.</A>
+</NOFRAMES>
+</FRAMESET>
+</HTML>
Added: incubator/abdera/site/trunk/docs/api/org/apache/abdera/factory/ExtensionFactory.html
URL: http://svn.apache.org/viewvc/incubator/abdera/site/trunk/docs/api/org/apache/abdera/factory/ExtensionFactory.html?rev=414919&view=auto
==============================================================================
--- incubator/abdera/site/trunk/docs/api/org/apache/abdera/factory/ExtensionFactory.html (added)
+++ incubator/abdera/site/trunk/docs/api/org/apache/abdera/factory/ExtensionFactory.html Fri Jun 16 14:25:31 2006
@@ -0,0 +1,306 @@
+<!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) on Fri Jun 16 14:22:49 PDT 2006 -->
+<TITLE>
+ExtensionFactory (Abdera)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.abdera.factory.ExtensionFactory interface">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+ parent.document.title="ExtensionFactory (Abdera)";
+}
+</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"> <A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A> </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-all.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">
+ PREV CLASS
+ <A HREF="../../../../org/apache/abdera/factory/Factory.html" title="interface in org.apache.abdera.factory"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?org/apache/abdera/factory/ExtensionFactory.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="ExtensionFactory.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>
+<A NAME="main"></A>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+org.apache.abdera.factory</FONT>
+<BR>
+Interface ExtensionFactory</H2>
+<HR>
+<DL>
+<DT><PRE>public interface <B>ExtensionFactory</B></DL>
+</PRE>
+
+<P>
+<DL>
+<DT><B>Author:</B></DT>
+ <DD>James M Snell (jasnell@us.ibm.com)
+
+ Extension Factories are used to provide a means of dynamically resolving
+ builders for namespaced extension elements
+
+ There are four ways of supporting extension elements.
+
+ 1. Implement your own Factory (hard)
+ 2. Subclass the default Axiom-based Factory (also somewhat difficult)
+ 3. Implement and register an ExtensionFactory (wonderfully simple)
+ 4. Use the Feed Object Model's dynamic support for extensions (also very simple)
+
+ Registering an Extension Factory requires generally nothing more than
+ implementing ExtensionFactory and then creating the file
+ META-INF/services/org.apache.abdera.factory.ExtensionFactory and listing
+ the class names of each ExtensionFactory you wish to register.
+
+ Note that at this time, ExtensionFactories are specific to the parser
+ implementation used. That is, if you're using the default StAX-based
+ FOMParser and FOMFactory implementation, your ExtensionFactores will
+ need to also implement FOMExtensionFactory.</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> java.lang.String</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/abdera/factory/ExtensionFactory.html#getNamespace()">getNamespace</A></B>()</CODE>
+
+<BR>
+ Returns the Namespace URI handled by this Extension Factory.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
+<TR ALIGN="right" VALIGN="">
+<TD NOWRAP><FONT SIZE="-1">
+<CODE><T extends <A HREF="../../../../org/apache/abdera/model/ExtensionElement.html" title="interface in org.apache.abdera.model">ExtensionElement</A>>
+<BR>
+T</CODE></FONT></TD>
+</TR>
+</TABLE>
+</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/abdera/factory/ExtensionFactory.html#newExtensionElement(javax.xml.namespace.QName, org.apache.abdera.model.Document, org.apache.abdera.factory.Factory)">newExtensionElement</A></B>(javax.xml.namespace.QName qname,
+ <A HREF="../../../../org/apache/abdera/model/Document.html" title="interface in org.apache.abdera.model">Document</A> parent,
+ <A HREF="../../../../org/apache/abdera/factory/Factory.html" title="interface in org.apache.abdera.factory">Factory</A> factory)</CODE>
+
+<BR>
+ Called by the Factory implementaton to create an instance of the
+ extension element.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" SUMMARY="">
+<TR ALIGN="right" VALIGN="">
+<TD NOWRAP><FONT SIZE="-1">
+<CODE><T extends <A HREF="../../../../org/apache/abdera/model/ExtensionElement.html" title="interface in org.apache.abdera.model">ExtensionElement</A>>
+<BR>
+T</CODE></FONT></TD>
+</TR>
+</TABLE>
+</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../../org/apache/abdera/factory/ExtensionFactory.html#newExtensionElement(javax.xml.namespace.QName, org.apache.abdera.model.Element, org.apache.abdera.factory.Factory)">newExtensionElement</A></B>(javax.xml.namespace.QName qname,
+ <A HREF="../../../../org/apache/abdera/model/Element.html" title="interface in org.apache.abdera.model">Element</A> parent,
+ <A HREF="../../../../org/apache/abdera/factory/Factory.html" title="interface in org.apache.abdera.factory">Factory</A> factory)</CODE>
+
+<BR>
+ Called by the Factory implementaton to create an instance of the
+ extension element.</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="getNamespace()"><!-- --></A><H3>
+getNamespace</H3>
+<PRE>
+java.lang.String <B>getNamespace</B>()</PRE>
+<DL>
+<DD>Returns the Namespace URI handled by this Extension Factory. Each
+ Extension Factory implementation should handle exactly one namespace.
+<P>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>The Namespace URI</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="newExtensionElement(javax.xml.namespace.QName, org.apache.abdera.model.Element, org.apache.abdera.factory.Factory)"><!-- --></A><H3>
+newExtensionElement</H3>
+<PRE>
+<T extends <A HREF="../../../../org/apache/abdera/model/ExtensionElement.html" title="interface in org.apache.abdera.model">ExtensionElement</A>> T <B>newExtensionElement</B>(javax.xml.namespace.QName qname,
+ <A HREF="../../../../org/apache/abdera/model/Element.html" title="interface in org.apache.abdera.model">Element</A> parent,
+ <A HREF="../../../../org/apache/abdera/factory/Factory.html" title="interface in org.apache.abdera.factory">Factory</A> factory)</PRE>
+<DL>
+<DD>Called by the Factory implementaton to create an instance of the
+ extension element. If parent is not null, the new element will
+ be automatically added as a child of the parent.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>qname</CODE> - the QName of the extension element<DD><CODE>parent</CODE> - the Parent of the extension element<DD><CODE>factory</CODE> - the Factory
+<DT><B>Returns:</B><DD>ExtensionElement The created ExtensionElement</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="newExtensionElement(javax.xml.namespace.QName, org.apache.abdera.model.Document, org.apache.abdera.factory.Factory)"><!-- --></A><H3>
+newExtensionElement</H3>
+<PRE>
+<T extends <A HREF="../../../../org/apache/abdera/model/ExtensionElement.html" title="interface in org.apache.abdera.model">ExtensionElement</A>> T <B>newExtensionElement</B>(javax.xml.namespace.QName qname,
+ <A HREF="../../../../org/apache/abdera/model/Document.html" title="interface in org.apache.abdera.model">Document</A> parent,
+ <A HREF="../../../../org/apache/abdera/factory/Factory.html" title="interface in org.apache.abdera.factory">Factory</A> factory)</PRE>
+<DL>
+<DD>Called by the Factory implementaton to create an instance of the
+ extension element. If parent is not null, the new element will
+ be automatically set as the root of the document.
+<P>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>qname</CODE> - the QName of the extension element<DD><CODE>parent</CODE> - the Parent of the extension element<DD><CODE>factory</CODE> - the Factory
+<DT><B>Returns:</B><DD>ExtensionElement The created ExtensionElement</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"> <A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A> </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-all.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">
+ PREV CLASS
+ <A HREF="../../../../org/apache/abdera/factory/Factory.html" title="interface in org.apache.abdera.factory"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+ <A HREF="../../../../index.html?org/apache/abdera/factory/ExtensionFactory.html" target="_top"><B>FRAMES</B></A>
+ <A HREF="ExtensionFactory.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>
+
+</BODY>
+</HTML>