//=================================================================================================
//ADOBE SYSTEMS INCORPORATED
//Copyright 2006-2007 Adobe Systems Incorporated
//All Rights Reserved
//
//NOTICE: Adobe permits you to use, modify, and distribute this file in accordance with the terms
//of the Adobe license agreement accompanying it.
//=================================================================================================
package com.adobe.xmp;
import java.io.InputStream;
import java.io.OutputStream;
import com.adobe.xmp.impl.XMPMetaImpl;
import com.adobe.xmp.impl.XMPMetaParser;
import com.adobe.xmp.impl.XMPSchemaRegistryImpl;
import com.adobe.xmp.impl.XMPSerializerHelper;
import com.adobe.xmp.options.ParseOptions;
import com.adobe.xmp.options.SerializeOptions;
/**
* Creates XMPMeta
-instances from an InputStream
*
* @since 30.01.2006
*/
public final class XMPMetaFactory
{
/** The singleton instance of the XMPSchemaRegistry
. */
private static XMPSchemaRegistry schema = new XMPSchemaRegistryImpl();
/** cache for version info */
private static XMPVersionInfo versionInfo = null;
/**
* Hides public constructor
*/
private XMPMetaFactory()
{
// EMPTY
}
/**
* @return Returns the singleton instance of the XMPSchemaRegistry
.
*/
public static XMPSchemaRegistry getSchemaRegistry()
{
return schema;
}
/**
* @return Returns an empty XMPMeta
-object.
*/
public static XMPMeta create()
{
return new XMPMetaImpl();
}
/**
* Parsing with default options.
* @see XMPMetaFactory#parse(InputStream, ParseOptions)
*
* @param in an InputStream
* @return Returns the XMPMeta
-object created from the input.
* @throws XMPException If the file is not well-formed XML or if the parsing fails.
*/
public static XMPMeta parse(InputStream in) throws XMPException
{
return parse(in, null);
}
/**
* These functions support parsing serialized RDF into an XMP object, and serailizing an XMP
* object into RDF. The input for parsing may be any valid Unicode
* encoding. ISO Latin-1 is also recognized, but its use is strongly discouraged. Serialization
* is always as UTF-8.
*
* parseFromBuffer()
parses RDF from an InputStream
. The encoding
* is recognized automatically.
*
* @param in an InputStream
* @param options Options controlling the parsing.
* The available options are:
*
XMPMeta
-object created from the input.
* @throws XMPException If the file is not well-formed XML or if the parsing fails.
*/
public static XMPMeta parse(InputStream in, ParseOptions options)
throws XMPException
{
return XMPMetaParser.parse(in, options);
}
/**
* Parsing with default options.
* @see XMPMetaFactory#parse(InputStream)
*
* @param packet a String contain an XMP-file.
* @return Returns the XMPMeta
-object created from the input.
* @throws XMPException If the file is not well-formed XML or if the parsing fails.
*/
public static XMPMeta parseFromString(String packet) throws XMPException
{
return parseFromString(packet, null);
}
/**
* Creates an XMPMeta
-object from a string.
* @see XMPMetaFactory#parseFromString(String, ParseOptions)
*
* @param packet a String contain an XMP-file.
* @param options Options controlling the parsing.
* @return Returns the XMPMeta
-object created from the input.
* @throws XMPException If the file is not well-formed XML or if the parsing fails.
*/
public static XMPMeta parseFromString(String packet, ParseOptions options)
throws XMPException
{
return XMPMetaParser.parse(packet, options);
}
/**
* Parsing with default options.
* @see XMPMetaFactory#parseFromBuffer(byte[], ParseOptions)
*
* @param buffer a String contain an XMP-file.
* @return Returns the XMPMeta
-object created from the input.
* @throws XMPException If the file is not well-formed XML or if the parsing fails.
*/
public static XMPMeta parseFromBuffer(byte[] buffer) throws XMPException
{
return parseFromBuffer(buffer, null);
}
/**
* Creates an XMPMeta
-object from a byte-buffer.
* @see XMPMetaFactory#parse(InputStream, ParseOptions)
*
* @param buffer a String contain an XMP-file.
* @param options Options controlling the parsing.
* @return Returns the XMPMeta
-object created from the input.
* @throws XMPException If the file is not well-formed XML or if the parsing fails.
*/
public static XMPMeta parseFromBuffer(byte[] buffer,
ParseOptions options) throws XMPException
{
return XMPMetaParser.parse(buffer, options);
}
/**
* Serializes an XMPMeta
-object as RDF into an OutputStream
* with default options.
*
* @param xmp a metadata object
* @param out an OutputStream
to write the serialized RDF to.
* @throws XMPException on serializsation errors.
*/
public static void serialize(XMPMeta xmp, OutputStream out) throws XMPException
{
serialize(xmp, out, null);
}
/**
* Serializes an XMPMeta
-object as RDF into an OutputStream
.
*
* @param xmp a metadata object
* @param options Options to control the serialization (see {@link SerializeOptions}).
* @param out an OutputStream
to write the serialized RDF to.
* @throws XMPException on serializsation errors.
*/
public static void serialize(XMPMeta xmp, OutputStream out, SerializeOptions options)
throws XMPException
{
assertImplementation(xmp);
XMPSerializerHelper.serialize((XMPMetaImpl) xmp, out, options);
}
/**
* Serializes an XMPMeta
-object as RDF into a byte buffer.
*
* @param xmp a metadata object
* @param options Options to control the serialization (see {@link SerializeOptions}).
* @return Returns a byte buffer containing the serialized RDF.
* @throws XMPException on serializsation errors.
*/
public static byte[] serializeToBuffer(XMPMeta xmp, SerializeOptions options)
throws XMPException
{
assertImplementation(xmp);
return XMPSerializerHelper.serializeToBuffer((XMPMetaImpl) xmp, options);
}
/**
* Serializes an XMPMeta
-object as RDF into a string. Note: Encoding
* is ignored when serializing to a string.
*
* @param xmp a metadata object
* @param options Options to control the serialization (see {@link SerializeOptions}).
* @return Returns a string containing the serialized RDF.
* @throws XMPException on serializsation errors.
*/
public static String serializeToString(XMPMeta xmp, SerializeOptions options)
throws XMPException
{
assertImplementation(xmp);
return XMPSerializerHelper.serializeToString((XMPMetaImpl) xmp, options);
}
/**
* @param xmp Asserts that xmp is compatible to XMPMetaImpl
.s
*/
private static void assertImplementation(XMPMeta xmp)
{
if (!(xmp instanceof XMPMetaImpl))
{
throw new UnsupportedOperationException("The serializing service works only" +
"with the XMPMeta implementation of this library");
}
}
/**
* Resets the schema registry to its original state (creates a new one).
* Be careful this might break all existing XMPMeta-objects and should be used
* only for testing purpurses.
*/
public static void reset()
{
schema = new XMPSchemaRegistryImpl();
}
/**
* Obtain version information. The XMPVersionInfo singleton is created the first time
* its requested.
*
* @return Returns the version information.
*/
public static synchronized XMPVersionInfo getVersionInfo()
{
if (versionInfo == null)
{
try
{
final int major = 5;
final int minor = 1;
final int micro = 0;
final int engBuild = 3;
final boolean debug = false;
// Adobe XMP Core 5.0-jc001 DEBUG-