org.restlet.ext.atom
Class Categories

java.lang.Object
  extended by org.restlet.representation.Variant
      extended by org.restlet.representation.RepresentationInfo
          extended by org.restlet.representation.Representation
              extended by org.restlet.representation.CharacterRepresentation
                  extended by org.restlet.representation.WriterRepresentation
                      extended by org.restlet.ext.xml.XmlRepresentation
                          extended by org.restlet.ext.xml.SaxRepresentation
                              extended by org.restlet.ext.atom.Categories
All Implemented Interfaces:
NamespaceContext

public class Categories
extends SaxRepresentation

Collection of Category entries.

Author:
Jerome Louvel

Field Summary
 
Fields inherited from class org.restlet.representation.Representation
UNKNOWN_SIZE
 
Constructor Summary
Categories(Client clientDispatcher, String categoriesUri)
          Constructor.
Categories(Context context, String categoriesUri)
          Constructor.
Categories(Representation categoriesFeed)
          Constructor.
Categories(String categoriesUri)
          Constructor.
 
Method Summary
 Reference getBaseReference()
          Returns the base reference used to resolve relative references found within the scope of the xml:base attribute.
 List<Category> getEntries()
          Returns the list of entries.
 Reference getScheme()
          Returns the scheme.
 boolean isFixed()
          Indicates if the list is fixed.
 void setBaseReference(Reference baseReference)
          Sets the base reference used to resolve relative references found within the scope of the xml:base attribute.
 void setEntries(List<Category> entries)
          Sets the list of entries.
 void setFixed(boolean fixed)
          Indicates if the list is fixed.
 void setScheme(Reference scheme)
          Sets the scheme.
 void write(XmlWriter writer)
          Writes the representation to a XML writer.
 void writeElement(XmlWriter writer)
          Writes the representation to a XML writer.
 
Methods inherited from class org.restlet.ext.xml.SaxRepresentation
getInputSource, getSaxSource, isSecureProcessing, parse, release, setSaxSource, setSecureProcessing, write
 
Methods inherited from class org.restlet.ext.xml.XmlRepresentation
evaluate, getBoolean, getDocument, getDocumentBuilder, getDomSource, getEntityResolver, getErrorHandler, getNamespaces, getNamespaceURI, getNode, getNodes, getNumber, getPrefix, getPrefixes, getSaxSource, getSchema, getStreamSource, getText, isCoalescing, isExpandingEntityRefs, isIgnoringComments, isIgnoringExtraWhitespaces, isNamespaceAware, isValidatingDtd, isXIncludeAware, setCoalescing, setEntityResolver, setErrorHandler, setExpandingEntityRefs, setIgnoringComments, setIgnoringExtraWhitespaces, setNamespaceAware, setNamespaces, setSchema, setSchema, setValidatingDtd, setXIncludeAware, validate, validate, validate, validate
 
Methods inherited from class org.restlet.representation.WriterRepresentation
getReader
 
Methods inherited from class org.restlet.representation.CharacterRepresentation
getChannel, getStream, write, write
 
Methods inherited from class org.restlet.representation.Representation
append, exhaust, getAvailableSize, getDigest, getDisposition, getExpirationDate, getRange, getRegistration, getSize, getText, hasKnownSize, isAvailable, isEmpty, isSelectable, isTransient, setAvailable, setDigest, setDisposition, setExpirationDate, setListener, setRange, setSize, setTransient
 
Methods inherited from class org.restlet.representation.RepresentationInfo
getModificationDate, getTag, setModificationDate, setTag
 
Methods inherited from class org.restlet.representation.Variant
createClientInfo, equals, getCharacterSet, getEncodings, getLanguages, getLocationRef, getMediaType, includes, isCompatible, setCharacterSet, setEncodings, setLanguages, setLocationRef, setLocationRef, setMediaType, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Categories

public Categories(Client clientDispatcher,
                  String categoriesUri)
           throws IOException
Constructor.

Parameters:
clientDispatcher - The client HTTP dispatcher.
categoriesUri - The feed URI.
Throws:
IOException

Categories

public Categories(Context context,
                  String categoriesUri)
           throws IOException
Constructor.

Parameters:
context - The context from which the client dispatcher will be retrieved.
categoriesUri - The feed URI.
Throws:
IOException

Categories

public Categories(Representation categoriesFeed)
           throws IOException
Constructor.

Parameters:
categoriesFeed - The XML entries document.
Throws:
IOException

Categories

public Categories(String categoriesUri)
           throws IOException
Constructor.

Parameters:
categoriesUri - The feed URI.
Throws:
IOException
Method Detail

getBaseReference

public Reference getBaseReference()
Returns the base reference used to resolve relative references found within the scope of the xml:base attribute.

Returns:
The base reference used to resolve relative references found within the scope of the xml:base attribute.

getEntries

public List<Category> getEntries()
Returns the list of entries.

Returns:
The list of entries.

getScheme

public Reference getScheme()
Returns the scheme.

Returns:
The scheme.

isFixed

public boolean isFixed()
Indicates if the list is fixed.

Returns:
True if the list is fixed.

setBaseReference

public void setBaseReference(Reference baseReference)
Sets the base reference used to resolve relative references found within the scope of the xml:base attribute.

Parameters:
baseReference - The base reference used to resolve relative references found within the scope of the xml:base attribute.

setEntries

public void setEntries(List<Category> entries)
Sets the list of entries.

Parameters:
entries - The list of entries.

setFixed

public void setFixed(boolean fixed)
Indicates if the list is fixed.

Parameters:
fixed - True if the list is fixed.

setScheme

public void setScheme(Reference scheme)
Sets the scheme.

Parameters:
scheme - The scheme.

write

public void write(XmlWriter writer)
           throws IOException
Writes the representation to a XML writer.

Overrides:
write in class SaxRepresentation
Parameters:
writer - The XML writer to write to.
Throws:
IOException

writeElement

public void writeElement(XmlWriter writer)
                  throws SAXException
Writes the representation to a XML writer.

Parameters:
writer - The XML writer to write to.
Throws:
SAXException


Copyright © 2005-2013 Restlet.