Package org.mycore.common.content

Class MCRXMLContent

java.lang.Object

org.mycore.common.content.MCRContent

org.mycore.common.content.MCRXMLContent

Direct Known Subclasses:

MCRDOMContent, MCRJAXBContent, MCRJDOMContent, MCRSAXContent

public abstract class MCRXMLContent
extends MCRContent

Reads MCRContent from an XML document. Provides functionality to output XML using different formatters.

Author:

Frank Lützenkichen

Field Summary

Fields

Modifier and Type	Field	Description
protected static Format	defaultFormat	The default format used when outputting XML as a byte stream.
protected Format	format	The default format used when outputting this XML as a byte stream

Fields inherited from class org.mycore.common.content.MCRContent

docType, encoding, lastModified, length, mimeType, name, systemId, usingSession

Constructor Summary

Constructors

Constructor	Description
MCRXMLContent()

Method Summary

Modifier and Type	Method	Description
MCRContent	ensureXML()	Ensures that content is XML.
String	getETag()	Returns either strong or weak ETag.
InputStream	getInputStream()	Returns content as input stream.
String	getMimeType()
long	length()	Return the length of this content.
void	setEncoding(String encoding)
void	setFormat(Format format)	Sets the format used when outputting XML as a byte stream.

Methods inherited from class org.mycore.common.content.MCRContent

asByteArray, asDataURL, asString, asXML, getContentInputStream, getDataURLEncoding, getDocType, getEncoding, getInputSource, getName, getReadableByteChannel, getReusableCopy, getSafeEncoding, getSimpleWeakETag, getSource, getSystemId, isReusable, isUsingSession, lastModified, sendTo, sendTo, sendTo, sendTo, setDocType, setLastModified, setMimeType, setName, setUsingSession

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

defaultFormat

protected static Format defaultFormat

The default format used when outputting XML as a byte stream. By default, content is outputted using MCRConstants.DEFAULT_ENCODING. If MCR.IFS2.PrettyXML=true, a pretty format with indentation is used.

format

protected Format format

The default format used when outputting this XML as a byte stream

Constructor Details

MCRXMLContent

public MCRXMLContent()

Method Details

setFormat

public void setFormat(Format format)

Sets the format used when outputting XML as a byte stream. By default, content is outputted using MCRConstants.DEFAULT_ENCODING. If MCR.IFS2.PrettyXML=true, a pretty format with indentation is used.

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from class: MCRContent

Returns content as input stream. Be sure to close this stream properly!

Specified by:

getInputStream in class MCRContent

Returns:

input stream to read content from

Throws:

IOException

ensureXML

public MCRContent ensureXML()

Description copied from class: MCRContent

Ensures that content is XML. The content is parsed as if asXML() is called. When content is XML, an MCRContent instance is returned that guarantees that. When XML can not be parsed, an exception is thrown.

Overrides:

ensureXML in class MCRContent

getMimeType

public String getMimeType()
                   throws IOException

Overrides:

getMimeType in class MCRContent

Throws:

IOException

length

public long length()
            throws IOException

Description copied from class: MCRContent

Return the length of this content.

Overrides:

length in class MCRContent

Returns:

-1 if length is unknown

Throws:

IOException

getETag

public String getETag()
               throws IOException

Description copied from class: MCRContent

Returns either strong or weak ETag.

Overrides:

getETag in class MCRContent

Returns:

null, if no ETag could be generated

Throws:

IOException

setEncoding

public void setEncoding(String encoding)
                 throws UnsupportedEncodingException

Overrides:

setEncoding in class MCRContent

Throws:

UnsupportedEncodingException