org.apache.abdera.model
Interface Category

All Superinterfaces:
Base, java.lang.Cloneable, Element, ExtensibleElement

public interface Category
extends ExtensibleElement

Provides categorization informaton for a feed or entry

Per RFC4287:

  The "atom:category" element conveys information about a category
  associated with an entry or feed.  This specification assigns no
  meaning to the content (if any) of this element.

  atomCategory =
     element atom:category {
        atomCommonAttributes,
        attribute term { text },
        attribute scheme { atomUri }?,
        attribute label { text }?,
        undefinedContent
     }
 


Method Summary
 java.lang.String getLabel()
          RFC4287: The "label" attribute provides a human-readable label for display in end-user applications.
 org.apache.abdera.i18n.iri.IRI getScheme()
          RFC4287: The "scheme" attribute is an IRI that identifies a categorization scheme.
 java.lang.String getTerm()
          RFC4287: The "term" attribute is a string that identifies the category to which the entry or feed belongs.
 void setLabel(java.lang.String label)
          RFC4287: The "label" attribute provides a human-readable label for display in end-user applications.
 void setScheme(java.lang.String scheme)
          RFC4287: The "scheme" attribute is an IRI that identifies a categorization scheme.
 void setTerm(java.lang.String term)
          RFC4287: The "term" attribute is a string that identifies the category to which the entry or feed belongs.
 
Methods inherited from interface org.apache.abdera.model.ExtensibleElement
addExtension, addExtension, 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, getElements, getExtensionAttributes, getFirstChild, getFirstChild, getLanguage, getLanguageTag, getLocale, getMustPreserveWhitespace, getNamespaces, getNextSibling, getNextSibling, getParentElement, getPreviousSibling, getPreviousSibling, getQName, getResolvedBaseUri, getText, removeAttribute, setAttributeValue, setAttributeValue, setBaseUri, setBaseUri, setLanguage, setMustPreserveWhitespace, setParentElement, setText, setText
 
Methods inherited from interface org.apache.abdera.model.Base
addComment, clone, getDefaultWriterOptions, getFactory, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo, writeTo
 

Method Detail

getTerm

java.lang.String getTerm()
RFC4287: The "term" attribute is a string that identifies the category to which the entry or feed belongs. Category elements MUST have a "term" attribute.

Returns:
The string value of the term attribute

setTerm

void setTerm(java.lang.String term)
RFC4287: The "term" attribute is a string that identifies the category to which the entry or feed belongs. Category elements MUST have a "term" attribute.

Parameters:
term - The string value of the term attribute

getScheme

org.apache.abdera.i18n.iri.IRI getScheme()
RFC4287: The "scheme" attribute is an IRI that identifies a categorization scheme. Category elements MAY have a "scheme" attribute.

Returns:
The IRI value of the scheme attribute
Throws:
IRISyntaxException - if the scheme IRI is malformed

setScheme

void setScheme(java.lang.String scheme)
RFC4287: The "scheme" attribute is an IRI that identifies a categorization scheme. Category elements MAY have a "scheme" attribute.

Parameters:
scheme - The IRI of the scheme
Throws:
URISyntaxException - if the scheme provided is malformed

getLabel

java.lang.String getLabel()
RFC4287: The "label" attribute provides a human-readable label for display in end-user applications. The content of the "label" attribute is Language-Sensitive. Entities such as "&amp;" and "&lt;" represent their corresponding characters ("&" and "<", respectively), not markup. Category elements MAY have a "label" attribute.

Returns:
The value of the human-readable label

setLabel

void setLabel(java.lang.String label)
RFC4287: The "label" attribute provides a human-readable label for display in end-user applications. The content of the "label" attribute is Language-Sensitive. Entities such as "&amp;" and "&lt;" represent their corresponding characters ("&" and "<", respectively), not markup. Category elements MAY have a "label" attribute.

Parameters:
label - The value of the human-readable label