org.opencastproject.metadata.dublincore

Class DublinCoreXmlFormat

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.opencastproject.metadata.dublincore.DublinCoreXmlFormat

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

@ParametersAreNonnullByDefault
public final class DublinCoreXmlFormat
extends org.xml.sax.helpers.DefaultHandler

XML serialization of Dublin Core catalogs.

Field Summary

Fields

Modifier and Type	Field and Description
static com.entwinemedia.fn.Fn<String,com.entwinemedia.fn.data.Opt<DublinCoreCatalog>>	readOptFromString read(String) as a function, returning none on error.

Method Summary

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length)
void	endElement(String uri, String localName, String name)
void	error(SAXParseException e)
void	fatalError(SAXParseException e)
static DublinCoreCatalog	merge(DublinCoreCatalog fromCatalog, DublinCoreCatalog intoCatalog) Merge values that are new, changed, or emptied from the "from" catalog into the existing "into" catalog.
static DublinCoreCatalog	read(File xml) Read an XML encoded catalog from a file.
static DublinCoreCatalog	read(File xml, boolean includeEmptiedElements)
static DublinCoreCatalog	read(InputSource xml)
static DublinCoreCatalog	read(InputSource xml, boolean includeEmptiedElements)
static DublinCoreCatalog	read(InputStream xml) Read an XML encoded catalog from a stream.
static DublinCoreCatalog	read(Node xml)
static DublinCoreCatalog	read(Node xml, boolean includeEmptiedElements)
static DublinCoreCatalog	read(String xml) Read an XML encoded catalog from a string.
static DublinCoreCatalog	read(String xml, boolean includeEmptiedElements)
static com.entwinemedia.fn.data.Opt<DublinCoreCatalog>	readOpt(String xml)
void	startElement(String uri, String localName, String name, Attributes attributes) Read type attribute from track or catalog element.
void	startPrefixMapping(String prefix, String uri)
void	warning(SAXParseException e)
static Document	writeDocument(DublinCoreCatalog dc)
static String	writeString(DublinCoreCatalog dc)

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endDocument, endPrefixMapping, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, unparsedEntityDecl

Methods inherited from class java.lang.Object

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

Field Detail

readOptFromString

public static final com.entwinemedia.fn.Fn<String,com.entwinemedia.fn.data.Opt<DublinCoreCatalog>> readOptFromString

read(String) as a function, returning none on error.

Method Detail

read

@Nonnull
public static DublinCoreCatalog read(InputStream xml)
                                       throws IOException,
                                              SAXException,
                                              ParserConfigurationException

Read an XML encoded catalog from a stream.

Parameters:

xml - the input stream containing the DublinCore catalog

Returns:

the catalog representation

Throws:

ParserConfigurationException - if setting up the parser failed

SAXException - if an error occurred while parsing the document

IOException - if the stream cannot be accessed in a proper way

read

@Nonnull
public static DublinCoreCatalog read(File xml)
                                       throws IOException,
                                              SAXException,
                                              ParserConfigurationException

Read an XML encoded catalog from a file.

Parameters:

xml - the file containing the DublinCore catalog

Returns:

the catalog representation

Throws:

ParserConfigurationException - if setting up the parser failed

SAXException - if an error occurred while parsing the document

IOException - if the stream cannot be accessed in a proper way

read

@Nonnull
public static DublinCoreCatalog read(String xml)
                                       throws IOException,
                                              SAXException,
                                              ParserConfigurationException

Read an XML encoded catalog from a string.

Parameters:

xml - the string containing the DublinCore catalog

Returns:

the catalog representation

Throws:

ParserConfigurationException - if setting up the parser failed

SAXException - if an error occurred while parsing the document

IOException - if the stream cannot be accessed in a proper way

readOpt

public static com.entwinemedia.fn.data.Opt<DublinCoreCatalog> readOpt(String xml)

read

@Nonnull
public static DublinCoreCatalog read(Node xml)
                                       throws TransformerException

Throws:

TransformerException

read

@Nonnull
public static DublinCoreCatalog read(InputSource xml)
                                       throws IOException,
                                              SAXException,
                                              ParserConfigurationException

Throws:

IOException

SAXException

ParserConfigurationException

read

@Nonnull
public static DublinCoreCatalog read(String xml,
                                              boolean includeEmptiedElements)
                                       throws IOException,
                                              SAXException,
                                              ParserConfigurationException

Throws:

IOException

SAXException

ParserConfigurationException

read

@Nonnull
public static DublinCoreCatalog read(Node xml,
                                              boolean includeEmptiedElements)
                                       throws TransformerException

Throws:

TransformerException

read

@Nonnull
public static DublinCoreCatalog read(InputSource xml,
                                              boolean includeEmptiedElements)
                                       throws IOException,
                                              SAXException,
                                              ParserConfigurationException

Throws:

IOException

SAXException

ParserConfigurationException

read

@Nonnull
public static DublinCoreCatalog read(File xml,
                                              boolean includeEmptiedElements)
                                       throws IOException,
                                              SAXException,
                                              ParserConfigurationException

Throws:

IOException

SAXException

ParserConfigurationException

merge

public static DublinCoreCatalog merge(DublinCoreCatalog fromCatalog,
                                      DublinCoreCatalog intoCatalog)

Merge values that are new, changed, or emptied from the "from" catalog into the existing "into" catalog.

Parameters:

fromCatalog - contains targeted new values (new elements, changed element values, emptied element values).

intoCatalog - is the existing catalog that merges in the targed changes.

Returns:

the merged catalog

writeDocument

public static Document writeDocument(DublinCoreCatalog dc)
                              throws ParserConfigurationException,
                                     TransformerException,
                                     IOException

Throws:

ParserConfigurationException

TransformerException

IOException

writeString

public static String writeString(DublinCoreCatalog dc)

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws SAXException

Specified by:

characters in interface ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

startPrefixMapping

public void startPrefixMapping(String prefix,
                               String uri)
                        throws SAXException

Specified by:

startPrefixMapping in interface ContentHandler

Overrides:

startPrefixMapping in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

startElement

public void startElement(String uri,
                         String localName,
                         String name,
                         Attributes attributes)
                  throws SAXException

Read type attribute from track or catalog element.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

See Also:

DefaultHandler.startElement(String, String, String, org.xml.sax.Attributes)

endElement

public void endElement(String uri,
                       String localName,
                       String name)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

error

public void error(SAXParseException e)
           throws SAXException

Specified by:

error in interface ErrorHandler

Overrides:

error in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

fatalError

public void fatalError(SAXParseException e)
                throws SAXException

Specified by:

fatalError in interface ErrorHandler

Overrides:

fatalError in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException

warning

public void warning(SAXParseException e)
             throws SAXException

Specified by:

warning in interface ErrorHandler

Overrides:

warning in class org.xml.sax.helpers.DefaultHandler

Throws:

SAXException