| <!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) on Fri Jun 25 14:13:16 CDT 2010 --> | |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
| <TITLE> | |
| Categories (Apache Wink 1.1.1-incubating API) | |
| </TITLE> | |
| <META NAME="date" CONTENT="2010-06-25"> | |
| <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="Categories (Apache Wink 1.1.1-incubating 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> </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="class-use/Categories.html"><FONT CLASS="NavBarFont1"><B>Use</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="../../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</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/wink/common/categories/CollectionCategories.html" title="interface in org.apache.wink.common.categories"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../index.html?org/apache/wink/common/categories/Categories.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="Categories.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: FIELD | <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.wink.common.categories</FONT> | |
| <BR> | |
| Class Categories</H2> | |
| <PRE> | |
| java.lang.Object | |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.wink.common.categories.Categories</B> | |
| </PRE> | |
| <HR> | |
| <DL> | |
| <DT><PRE>public class <B>Categories</B><DT>extends java.lang.Object</DL> | |
| </PRE> | |
| <P> | |
| The Atom Publishing Protocol introduces the notion of a "Category Document" | |
| and the app:categories element. These are used to provide a listing of | |
| atom:Category elements that may be used with the members of an Atom | |
| Publishing Protocol collection. | |
| <P> | |
| <P> | |
| <HR> | |
| <P> | |
| <!-- ======== 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/wink/common/categories/Categories.html#Categories()">Categories</A></B>()</CODE> | |
| <BR> | |
| Constructor</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/wink/common/categories/Categories.html#Categories(java.util.List)">Categories</A></B>(java.util.List<<A HREF="../../../../../org/apache/wink/common/model/atom/AtomCategory.html" title="class in org.apache.wink.common.model.atom">AtomCategory</A>> categories)</CODE> | |
| <BR> | |
| Constructor</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> <A HREF="../../../../../org/apache/wink/common/categories/Categories.html" title="class in org.apache.wink.common.categories">Categories</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/wink/common/categories/Categories.html#addCategory(org.apache.wink.common.model.atom.AtomCategory)">addCategory</A></B>(<A HREF="../../../../../org/apache/wink/common/model/atom/AtomCategory.html" title="class in org.apache.wink.common.model.atom">AtomCategory</A> category)</CODE> | |
| <BR> | |
| Add an atom:Category to the listing</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../../org/apache/wink/common/model/atom/AtomCategory.html" title="class in org.apache.wink.common.model.atom">AtomCategory</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/wink/common/categories/Categories.html#addCategory(java.lang.String)">addCategory</A></B>(java.lang.String term)</CODE> | |
| <BR> | |
| Create and add an atom:Category to the listing</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../../org/apache/wink/common/model/atom/AtomCategory.html" title="class in org.apache.wink.common.model.atom">AtomCategory</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/wink/common/categories/Categories.html#addCategory(java.lang.String, java.lang.String, java.lang.String)">addCategory</A></B>(java.lang.String scheme, | |
| java.lang.String term, | |
| java.lang.String label)</CODE> | |
| <BR> | |
| Create an add an atom:Category to the listing</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/wink/common/categories/Categories.html#contains(java.lang.String)">contains</A></B>(java.lang.String term)</CODE> | |
| <BR> | |
| Returns true if this app:categories listing contains a Category with the | |
| specified term</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/wink/common/categories/Categories.html#contains(java.lang.String, java.lang.String)">contains</A></B>(java.lang.String term, | |
| java.lang.String scheme)</CODE> | |
| <BR> | |
| Returns true if this app:categories listing contains a Category with the | |
| specified term and scheme</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.List<<A HREF="../../../../../org/apache/wink/common/model/atom/AtomCategory.html" title="class in org.apache.wink.common.model.atom">AtomCategory</A>></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/wink/common/categories/Categories.html#getCategories()">getCategories</A></B>()</CODE> | |
| <BR> | |
| Lists the complete set of categories</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.List<<A HREF="../../../../../org/apache/wink/common/model/atom/AtomCategory.html" title="class in org.apache.wink.common.model.atom">AtomCategory</A>></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/wink/common/categories/Categories.html#getCategories(java.lang.String)">getCategories</A></B>(java.lang.String scheme)</CODE> | |
| <BR> | |
| Lists the complete set of categories that use the specified scheme</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.lang.Class<?></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/wink/common/categories/Categories.html#getHandlingClass()">getHandlingClass</A></B>()</CODE> | |
| <BR> | |
| Get Categories Document handling Resource class</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/wink/common/categories/Categories.html#getHandlingInstance()">getHandlingInstance</A></B>()</CODE> | |
| <BR> | |
| Get handling Bean for Categories Document</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/wink/common/categories/Categories.html#getHref()">getHref</A></B>()</CODE> | |
| <BR> | |
| When contained within an app:collection element, the app:categories | |
| element can have an href attribute whose value MUST point to an Atompub | |
| Categories Document.</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/wink/common/categories/Categories.html#getScheme()">getScheme</A></B>()</CODE> | |
| <BR> | |
| The app:categories element may specify a default scheme attribute for | |
| listed atom:Category elements that do not have their own scheme | |
| attribute.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/wink/common/categories/Categories.html#getTemplateParameters()">getTemplateParameters</A></B>()</CODE> | |
| <BR> | |
| Get Uri Template Variables</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/wink/common/categories/Categories.html#isFixed()">isFixed</A></B>()</CODE> | |
| <BR> | |
| If an app:categories element is marked as fixed, then the set of | |
| atom:Category elements is considered to be a closed set.</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/wink/common/categories/Categories.html#isOutOfLine()">isOutOfLine</A></B>()</CODE> | |
| <BR> | |
| Returns true if the href attribute is set</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/wink/common/categories/Categories.html#setCategories(java.util.List)">setCategories</A></B>(java.util.List<<A HREF="../../../../../org/apache/wink/common/model/atom/AtomCategory.html" title="class in org.apache.wink.common.model.atom">AtomCategory</A>> categories)</CODE> | |
| <BR> | |
| Set a list of categories</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../../org/apache/wink/common/categories/Categories.html" title="class in org.apache.wink.common.categories">Categories</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/wink/common/categories/Categories.html#setFixed(boolean)">setFixed</A></B>(boolean fixed)</CODE> | |
| <BR> | |
| Sets whether or not this is a fixed listing of categories.</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/wink/common/categories/Categories.html#setHref(java.lang.Class, javax.ws.rs.core.MultivaluedMap)">setHref</A></B>(java.lang.Class<?> handlingClass, | |
| javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> templateParams)</CODE> | |
| <BR> | |
| Set Resource class that will generate Categories Document</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/wink/common/categories/Categories.html#setHref(java.lang.Object, javax.ws.rs.core.MultivaluedMap)">setHref</A></B>(java.lang.Object handlingInstance, | |
| javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> templateParams)</CODE> | |
| <BR> | |
| Set Resource that will generate Categories Document</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../../org/apache/wink/common/categories/Categories.html" title="class in org.apache.wink.common.categories">Categories</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/wink/common/categories/Categories.html#setHref(java.lang.String)">setHref</A></B>(java.lang.String href)</CODE> | |
| <BR> | |
| Sets the value of the href attribute.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../../org/apache/wink/common/categories/Categories.html" title="class in org.apache.wink.common.categories">Categories</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/wink/common/categories/Categories.html#setScheme(java.lang.String)">setScheme</A></B>(java.lang.String scheme)</CODE> | |
| <BR> | |
| Sets the default scheme for this listing of categories</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/wink/common/categories/Categories.html#setTemplateParameters(javax.ws.rs.core.MultivaluedMap)">setTemplateParameters</A></B>(javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> templateParams)</CODE> | |
| <BR> | |
| Set Uri Template Variables</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, toString, wait, wait, wait</CODE></TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <P> | |
| <!-- ========= 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="Categories(java.util.List)"><!-- --></A><H3> | |
| Categories</H3> | |
| <PRE> | |
| public <B>Categories</B>(java.util.List<<A HREF="../../../../../org/apache/wink/common/model/atom/AtomCategory.html" title="class in org.apache.wink.common.model.atom">AtomCategory</A>> categories)</PRE> | |
| <DL> | |
| <DD>Constructor | |
| <P> | |
| <DL> | |
| <DT><B>Parameters:</B><DD><CODE>categories</CODE> - </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="Categories()"><!-- --></A><H3> | |
| Categories</H3> | |
| <PRE> | |
| public <B>Categories</B>()</PRE> | |
| <DL> | |
| <DD>Constructor | |
| <P> | |
| <DL> | |
| <DT><B>Parameters:</B><DD><CODE>categories</CODE> - </DL> | |
| </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="getHref()"><!-- --></A><H3> | |
| getHref</H3> | |
| <PRE> | |
| public java.lang.String <B>getHref</B>()</PRE> | |
| <DL> | |
| <DD>When contained within an app:collection element, the app:categories | |
| element can have an href attribute whose value MUST point to an Atompub | |
| Categories Document. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>The href attribute value</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setHref(java.lang.String)"><!-- --></A><H3> | |
| setHref</H3> | |
| <PRE> | |
| public <A HREF="../../../../../org/apache/wink/common/categories/Categories.html" title="class in org.apache.wink.common.categories">Categories</A> <B>setHref</B>(java.lang.String href)</PRE> | |
| <DL> | |
| <DD>Sets the value of the href attribute. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>href</CODE> - The location of an Atompub Categories Document</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setHref(java.lang.Class, javax.ws.rs.core.MultivaluedMap)"><!-- --></A><H3> | |
| setHref</H3> | |
| <PRE> | |
| public void <B>setHref</B>(java.lang.Class<?> handlingClass, | |
| javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> templateParams)</PRE> | |
| <DL> | |
| <DD>Set Resource class that will generate Categories Document | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>handlingClass</CODE> - Resource Class<DD><CODE>templateParams</CODE> - Map of URI variable names and their values</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setHref(java.lang.Object, javax.ws.rs.core.MultivaluedMap)"><!-- --></A><H3> | |
| setHref</H3> | |
| <PRE> | |
| public void <B>setHref</B>(java.lang.Object handlingInstance, | |
| javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> templateParams)</PRE> | |
| <DL> | |
| <DD>Set Resource that will generate Categories Document | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>handlingInstance</CODE> - Resource instance<DD><CODE>templateParams</CODE> - Map of URI variable names and their values</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isFixed()"><!-- --></A><H3> | |
| isFixed</H3> | |
| <PRE> | |
| public boolean <B>isFixed</B>()</PRE> | |
| <DL> | |
| <DD>If an app:categories element is marked as fixed, then the set of | |
| atom:Category elements is considered to be a closed set. That is, Atom | |
| Publishing Protocol clients SHOULD only use the atom:Category elements | |
| listed. The default is false (fixed="no") | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>True if the categories listing is fixed</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setFixed(boolean)"><!-- --></A><H3> | |
| setFixed</H3> | |
| <PRE> | |
| public <A HREF="../../../../../org/apache/wink/common/categories/Categories.html" title="class in org.apache.wink.common.categories">Categories</A> <B>setFixed</B>(boolean fixed)</PRE> | |
| <DL> | |
| <DD>Sets whether or not this is a fixed listing of categories. If set to | |
| false, the fixed attribute will be removed from the app:categories | |
| element. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>fixed</CODE> - True if the app:categories listing is fixed</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getScheme()"><!-- --></A><H3> | |
| getScheme</H3> | |
| <PRE> | |
| public java.lang.String <B>getScheme</B>()</PRE> | |
| <DL> | |
| <DD>The app:categories element may specify a default scheme attribute for | |
| listed atom:Category elements that do not have their own scheme | |
| attribute. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>The scheme String</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setScheme(java.lang.String)"><!-- --></A><H3> | |
| setScheme</H3> | |
| <PRE> | |
| public <A HREF="../../../../../org/apache/wink/common/categories/Categories.html" title="class in org.apache.wink.common.categories">Categories</A> <B>setScheme</B>(java.lang.String scheme)</PRE> | |
| <DL> | |
| <DD>Sets the default scheme for this listing of categories | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>scheme</CODE> - The default scheme used for this listing of categories</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getCategories()"><!-- --></A><H3> | |
| getCategories</H3> | |
| <PRE> | |
| public java.util.List<<A HREF="../../../../../org/apache/wink/common/model/atom/AtomCategory.html" title="class in org.apache.wink.common.model.atom">AtomCategory</A>> <B>getCategories</B>()</PRE> | |
| <DL> | |
| <DD>Lists the complete set of categories | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>This app:categories listing of atom:Category elements</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getCategories(java.lang.String)"><!-- --></A><H3> | |
| getCategories</H3> | |
| <PRE> | |
| public java.util.List<<A HREF="../../../../../org/apache/wink/common/model/atom/AtomCategory.html" title="class in org.apache.wink.common.model.atom">AtomCategory</A>> <B>getCategories</B>(java.lang.String scheme)</PRE> | |
| <DL> | |
| <DD>Lists the complete set of categories that use the specified scheme | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>scheme</CODE> - The String of an atom:Category scheme | |
| <DT><B>Returns:</B><DD>A listing of atom:Category elements that use the specified scheme</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="addCategory(org.apache.wink.common.model.atom.AtomCategory)"><!-- --></A><H3> | |
| addCategory</H3> | |
| <PRE> | |
| public <A HREF="../../../../../org/apache/wink/common/categories/Categories.html" title="class in org.apache.wink.common.categories">Categories</A> <B>addCategory</B>(<A HREF="../../../../../org/apache/wink/common/model/atom/AtomCategory.html" title="class in org.apache.wink.common.model.atom">AtomCategory</A> category)</PRE> | |
| <DL> | |
| <DD>Add an atom:Category to the listing | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>Category</CODE> - The atom:Category to add to the listing</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="addCategory(java.lang.String)"><!-- --></A><H3> | |
| addCategory</H3> | |
| <PRE> | |
| public <A HREF="../../../../../org/apache/wink/common/model/atom/AtomCategory.html" title="class in org.apache.wink.common.model.atom">AtomCategory</A> <B>addCategory</B>(java.lang.String term)</PRE> | |
| <DL> | |
| <DD>Create and add an atom:Category to the listing | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>term</CODE> - The string term | |
| <DT><B>Returns:</B><DD>The newly created atom:Category</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="addCategory(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> | |
| addCategory</H3> | |
| <PRE> | |
| public <A HREF="../../../../../org/apache/wink/common/model/atom/AtomCategory.html" title="class in org.apache.wink.common.model.atom">AtomCategory</A> <B>addCategory</B>(java.lang.String scheme, | |
| java.lang.String term, | |
| java.lang.String label)</PRE> | |
| <DL> | |
| <DD>Create an add an atom:Category to the listing | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>scheme</CODE> - The scheme String for the newly created Category<DD><CODE>term</CODE> - The string term<DD><CODE>label</CODE> - The human readable label for the Category | |
| <DT><B>Returns:</B><DD>The newly created atom:Category</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="contains(java.lang.String)"><!-- --></A><H3> | |
| contains</H3> | |
| <PRE> | |
| public boolean <B>contains</B>(java.lang.String term)</PRE> | |
| <DL> | |
| <DD>Returns true if this app:categories listing contains a Category with the | |
| specified term | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>term</CODE> - The term to look for | |
| <DT><B>Returns:</B><DD>True if the term is found</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="contains(java.lang.String, java.lang.String)"><!-- --></A><H3> | |
| contains</H3> | |
| <PRE> | |
| public boolean <B>contains</B>(java.lang.String term, | |
| java.lang.String scheme)</PRE> | |
| <DL> | |
| <DD>Returns true if this app:categories listing contains a Category with the | |
| specified term and scheme | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>term</CODE> - The term to look for<DD><CODE>scheme</CODE> - The String scheme | |
| <DT><B>Returns:</B><DD>True if the term and scheme are found</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="isOutOfLine()"><!-- --></A><H3> | |
| isOutOfLine</H3> | |
| <PRE> | |
| public boolean <B>isOutOfLine</B>()</PRE> | |
| <DL> | |
| <DD>Returns true if the href attribute is set | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getHandlingClass()"><!-- --></A><H3> | |
| getHandlingClass</H3> | |
| <PRE> | |
| public java.lang.Class<?> <B>getHandlingClass</B>()</PRE> | |
| <DL> | |
| <DD>Get Categories Document handling Resource class | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>Resource class</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setCategories(java.util.List)"><!-- --></A><H3> | |
| setCategories</H3> | |
| <PRE> | |
| public void <B>setCategories</B>(java.util.List<<A HREF="../../../../../org/apache/wink/common/model/atom/AtomCategory.html" title="class in org.apache.wink.common.model.atom">AtomCategory</A>> categories)</PRE> | |
| <DL> | |
| <DD>Set a list of categories | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>categories</CODE> - </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getHandlingInstance()"><!-- --></A><H3> | |
| getHandlingInstance</H3> | |
| <PRE> | |
| public java.lang.Object <B>getHandlingInstance</B>()</PRE> | |
| <DL> | |
| <DD>Get handling Bean for Categories Document | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>handlingBean</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getTemplateParameters()"><!-- --></A><H3> | |
| getTemplateParameters</H3> | |
| <PRE> | |
| public javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> <B>getTemplateParameters</B>()</PRE> | |
| <DL> | |
| <DD>Get Uri Template Variables | |
| <P> | |
| <DD><DL> | |
| <DT><B>Returns:</B><DD>templateParams</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="setTemplateParameters(javax.ws.rs.core.MultivaluedMap)"><!-- --></A><H3> | |
| setTemplateParameters</H3> | |
| <PRE> | |
| public void <B>setTemplateParameters</B>(javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> templateParams)</PRE> | |
| <DL> | |
| <DD>Set Uri Template Variables | |
| <P> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>templateParams</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="class-use/Categories.html"><FONT CLASS="NavBarFont1"><B>Use</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="../../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</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/wink/common/categories/CollectionCategories.html" title="interface in org.apache.wink.common.categories"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../index.html?org/apache/wink/common/categories/Categories.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="Categories.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 | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: FIELD | <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> | |
| Copyright © 2009-2010 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. | |
| </BODY> | |
| </HTML> |