fop 0.92beta

org.apache.fop.fo.extensions.xmp
Class XMPMetadata

java.lang.Object
  extended byorg.apache.fop.fo.extensions.xmp.XMPMetadata
All Implemented Interfaces:
ExtensionAttachment, java.io.Serializable, XMLizable

public class XMPMetadata
extends java.lang.Object
implements ExtensionAttachment, java.io.Serializable, XMLizable

This is the pass-through value object for the XMP metadata extension.

See Also:
Serialized Form

Field Summary
static java.lang.String CATEGORY
          The category URI for this extension attachment.
 
Constructor Summary
XMPMetadata()
          No-argument contructor.
XMPMetadata(org.w3c.dom.Document doc)
          Default constructor.
 
Method Summary
 java.lang.String getCategory()
          This method returns a category URI that allows a processor (layout manager or renderer) to determine if it supports this object.
 org.w3c.dom.Document getDocument()
           
 boolean isReadOnly()
           
 void setDocument(org.w3c.dom.Document document)
          Sets the DOM document containing the XMP metadata.
 void setReadOnly(boolean readOnly)
          Sets the flag that decides whether a metadata packet may be modified.
 void toSAX(org.xml.sax.ContentHandler handler)
          Generates SAX events representing the object's state.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CATEGORY

public static final java.lang.String CATEGORY
The category URI for this extension attachment.

See Also:
Constant Field Values
Constructor Detail

XMPMetadata

public XMPMetadata()
No-argument contructor.


XMPMetadata

public XMPMetadata(org.w3c.dom.Document doc)
Default constructor.

Parameters:
doc - the DOM document containing the XMP metadata
Method Detail

getDocument

public org.w3c.dom.Document getDocument()
Returns:
the DOM document containing the XMP metadata

setDocument

public void setDocument(org.w3c.dom.Document document)
Sets the DOM document containing the XMP metadata.

Parameters:
document - the DOM document

isReadOnly

public boolean isReadOnly()
Returns:
true if the XMP metadata is marked read-only.

setReadOnly

public void setReadOnly(boolean readOnly)
Sets the flag that decides whether a metadata packet may be modified.

Parameters:
readOnly - true if the XMP metadata packet should be marked read-only.

getCategory

public java.lang.String getCategory()
Description copied from interface: ExtensionAttachment
This method returns a category URI that allows a processor (layout manager or renderer) to determine if it supports this object.

Specified by:
getCategory in interface ExtensionAttachment
Returns:
the category URI
See Also:
ExtensionAttachment.getCategory()

toSAX

public void toSAX(org.xml.sax.ContentHandler handler)
           throws org.xml.sax.SAXException
Description copied from interface: XMLizable
Generates SAX events representing the object's state.

Specified by:
toSAX in interface XMLizable
Parameters:
handler - ContentHandler instance to send the SAX events to
Throws:
org.xml.sax.SAXException - if there's a problem generating the SAX events
See Also:
XMLizable.toSAX(org.xml.sax.ContentHandler)

fop 0.92beta

Copyright 1999-2006 The Apache Software Foundation. All Rights Reserved.