Package org.apache.abdera.model

Interface Categories

  • All Superinterfaces:
    Base, java.lang.Cloneable, Element, ExtensibleElement, java.lang.Iterable<Element>
    @Deprecated(since="2021-07-29")
public interface Categories
extends ExtensibleElement
    Deprecated.
    This API is deprecated as Apache Abdera is a retired project since 2017.
    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 Detail

      • getHref

        IRI getHref()
        Deprecated.
        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.
        Returns:
        The href attribute value

      • getResolvedHref

        IRI getResolvedHref()
        Deprecated.
        Returns the value of the href attribute resolved against the in-scope Base URI
        Returns:
        The fully resolved href attribute value

      • setHref

        Categories setHref​(java.lang.String href)
        Deprecated.
        Sets the value of the href attribute.
        Parameters:
        href - The location of an Atompub Categories Document

      • isFixed

        boolean isFixed()
        Deprecated.
        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")
        Returns:
        True if the categories listing is fixed

      • setFixed

        Categories setFixed​(boolean fixed)
        Deprecated.
        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.
        Parameters:
        fixed - True if the app:categories listing is fixed

      • getScheme

        IRI getScheme()
        Deprecated.
        The app:categories element may specify a default scheme attribute for listed atom:category elements that do not have their own scheme attribute.
        Returns:
        The scheme IRI

      • setScheme

        Categories setScheme​(java.lang.String scheme)
        Deprecated.
        Sets the default scheme for this listing of categories
        Parameters:
        scheme - The default scheme used for this listing of categories

      • getCategories

        java.util.List<Category> getCategories()
        Deprecated.
        Lists the complete set of categories
        Returns:
        This app:categories listing of atom:category elements

      • getCategories

        java.util.List<Category> getCategories​(java.lang.String scheme)
        Deprecated.
        Lists the complete set of categories that use the specified scheme
        Parameters:
        scheme - The IRI of an atom:category scheme
        Returns:
        A listing of atom:category elements that use the specified scheme

      • getCategoriesWithScheme

        java.util.List<Category> getCategoriesWithScheme()
        Deprecated.
        Returns a copy of the complete set of categories with the scheme attribute set
        Returns:
        A listing of atom:category elements using the default scheme specified by the app:categories scheme attribute

      • getCategoriesWithScheme

        java.util.List<Category> getCategoriesWithScheme​(java.lang.String scheme)
        Deprecated.
        Returns a copy of the complete set of categories with the scheme attribute set as specified in 7.2.1. (child categories that do not have a scheme attribute inherit the scheme attribute of the parent)
        Parameters:
        scheme - A scheme IRI
        Returns:
        A listing of atom:category elements

      • addCategory

        Categories addCategory​(Category category)
        Deprecated.
        Add an atom:category to the listing
        Parameters:
        category - The atom:category to add to the listing

      • addCategory

        Category addCategory​(java.lang.String term)
        Deprecated.
        Create and add an atom:category to the listing
        Parameters:
        term - The string term
        Returns:
        The newly created atom:category

      • addCategory

        Category addCategory​(java.lang.String scheme,
                     java.lang.String term,
                     java.lang.String label)
        Deprecated.
        Create an add an atom:category to the listing
        Parameters:
        scheme - The scheme IRI for the newly created category
        term - The string term
        label - The human readable label for the category
        Returns:
        The newly created atom:category

      • contains

        boolean contains​(java.lang.String term)
        Deprecated.
        Returns true if this app:categories listing contains a category with the specified term
        Parameters:
        term - The term to look for
        Returns:
        True if the term is found

      • contains

        boolean contains​(java.lang.String term,
                 java.lang.String scheme)
        Deprecated.
        Returns true if this app:categories listing contains a category with the specified term and scheme
        Parameters:
        term - The term to look for
        scheme - The IRI scheme
        Returns:
        True if the term and scheme are found

      • isOutOfLine

        boolean isOutOfLine()
        Deprecated.
        Returns true if the href attribute is set