|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Categories
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.
Method Summary | |
---|---|
void |
addCategory(Category category)
Add an atom:category to the listing |
Category |
addCategory(java.lang.String term)
Create and add an atom:category to the listing |
Category |
addCategory(java.lang.String scheme,
java.lang.String term,
java.lang.String label)
Create an add an atom:category to the listing |
boolean |
contains(java.lang.String term)
Returns true if this app:categories listing contains a category with the specified term |
boolean |
contains(java.lang.String term,
java.lang.String scheme)
Returns true if this app:categories listing contains a category with the specified term and scheme |
java.util.List<Category> |
getCategories()
Lists the complete set of categories |
java.util.List<Category> |
getCategories(java.lang.String scheme)
Lists the complete set of categories that use the specified scheme |
java.util.List<Category> |
getCategoriesWithScheme()
Returns a copy of the complete set of categories with the scheme attribute set |
java.util.List<Category> |
getCategoriesWithScheme(java.lang.String scheme)
Returns a copy of the complete set of categories with the scheme attribute set as specified in 7.2.1. |
IRI |
getHref()
The app:categories element can have an href attribute whose value MUST point to an APP Category Document. |
IRI |
getResolvedHref()
Returns the value of the href attribute resolved against the in-scope Base URI |
IRI |
getScheme()
The app:categories element may specify a default scheme attribute for listed atom:category elements that do not have their own scheme attribute. |
boolean |
isFixed()
If an app:categories element is marked as fixed, then the set of atom:category elements is considered to be a closed set. |
void |
setFixed(boolean fixed)
Sets whether or not this is a fixed listing of categories. |
void |
setHref(java.lang.String href)
Sets the value of the href attribute. |
void |
setScheme(java.lang.String scheme)
Sets the default scheme for this listing of categories |
Methods inherited from interface org.apache.abdera.model.ExtensibleElement |
---|
addExtension, addExtension, addExtension, addSimpleExtension, addSimpleExtension, getExtension, getExtension, getExtensions, getExtensions, getExtensions, getSimpleExtension, getSimpleExtension |
Methods inherited from interface org.apache.abdera.model.Element |
---|
declareNS, discard, getAttributes, getAttributeValue, getAttributeValue, getBaseUri, getDocument, getExtensionAttributes, getFirstChild, getFirstChild, getLanguage, getLanguageTag, getLocale, getNextSibling, getNextSibling, getParentElement, getPreviousSibling, getPreviousSibling, getQName, getResolvedBaseUri, getText, removeAttribute, setAttributeValue, setAttributeValue, setBaseUri, setBaseUri, setLanguage, setParentElement, setText |
Methods inherited from interface org.apache.abdera.model.Base |
---|
addComment, clone, getFactory, writeTo, writeTo |
Method Detail |
---|
IRI getHref() throws IRISyntaxException
IRISyntaxException
- if the IRI in the underlying attribute value is malformedIRI getResolvedHref() throws IRISyntaxException
URISyntaxException
- if the IRI in the underlying attribute value is malformed
IRISyntaxException
void setHref(java.lang.String href) throws IRISyntaxException
URISyntaxException
- if the IRI specified is malformed
IRISyntaxException
boolean isFixed()
void setFixed(boolean fixed)
fixed
- True if the app:categories listing is fixedIRI getScheme() throws IRISyntaxException
IRISyntaxException
- if the IRI in the scheme attribute is malformedvoid setScheme(java.lang.String scheme) throws IRISyntaxException
scheme
- The default scheme used for this listing of categories
IRISyntaxException
- if the IRI provided is malformedjava.util.List<Category> getCategories()
java.util.List<Category> getCategories(java.lang.String scheme) throws IRISyntaxException
scheme
- The IRI of an atom:category scheme
IRISyntaxException
- if the scheme provided is malformedjava.util.List<Category> getCategoriesWithScheme() throws IRISyntaxException
IRISyntaxException
- if the values of the scheme attributes are malformedjava.util.List<Category> getCategoriesWithScheme(java.lang.String scheme) throws IRISyntaxException
scheme
- A scheme IRI
IRISyntaxException
- if the scheme provided is malformedvoid addCategory(Category category)
category
- The atom:category to add to the listingCategory addCategory(java.lang.String term)
term
- The string term
Category addCategory(java.lang.String scheme, java.lang.String term, java.lang.String label) throws IRISyntaxException
scheme
- The scheme IRI for the newly created categoryterm
- The string termlabel
- The human readable label for the category
IRISyntaxException
- if the scheme provided is malformedboolean contains(java.lang.String term) throws IRISyntaxException
term
- The term to look for
IRISyntaxException
- if the Scheme IRI of any of the scheme attributes is malformedboolean contains(java.lang.String term, java.lang.String scheme) throws IRISyntaxException
term
- The term to look forscheme
- The IRI scheme
IRISyntaxException
- if the Scheme IRI of any of the scheme attributes is malformed
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |