xmlgraphics-commons 1.3

org.apache.xmlgraphics.xmp
Class XMPStructure

java.lang.Object
  extended by org.apache.xmlgraphics.xmp.XMPComplexValue
      extended by org.apache.xmlgraphics.xmp.XMPStructure
All Implemented Interfaces:
XMLizable, PropertyAccess

public class XMPStructure
extends XMPComplexValue
implements PropertyAccess

Represents an XMP structure as defined by the XMP specification.


Constructor Summary
XMPStructure()
          Main constructor
 
Method Summary
 XMPProperty getProperty(QName name)
          Returns a property.
 XMPProperty getProperty(java.lang.String uri, java.lang.String localName)
          Returns a property
 int getPropertyCount()
          Returns the number of properties.
 java.lang.Object getSimpleValue()
          Returns a normal Java object representing the value if it is available.
 XMPProperty getValueProperty()
          Returns the rdf:value property.
 java.util.Iterator iterator()
          Returns an Iterator over all properties in this structured property.
 void setProperty(XMPProperty prop)
          Sets a property.
 void toSAX(org.xml.sax.ContentHandler handler)
          Generates SAX events representing the object's state.
 java.lang.String toString()
          
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

XMPStructure

public XMPStructure()
Main constructor

Method Detail

getSimpleValue

public java.lang.Object getSimpleValue()
Returns a normal Java object representing the value if it is available.

Specified by:
getSimpleValue in class XMPComplexValue
Returns:
a simple object value or null if no such value can be returned (for example, because the value is an array and has multiple entries.

setProperty

public void setProperty(XMPProperty prop)
Sets a property.

Specified by:
setProperty in interface PropertyAccess
Parameters:
prop - the property

getProperty

public XMPProperty getProperty(java.lang.String uri,
                               java.lang.String localName)
Returns a property

Specified by:
getProperty in interface PropertyAccess
Parameters:
uri - the namespace URI of the property
localName - the local name of the property
Returns:
the requested property or null if it's not available

getValueProperty

public XMPProperty getValueProperty()
Returns the rdf:value property. This is a shortcut for getProperty(XMPConstants.RDF_VALUE).

Specified by:
getValueProperty in interface PropertyAccess
Returns:
the rdf:value property or null if it's no available

getProperty

public XMPProperty getProperty(QName name)
Returns a property.

Specified by:
getProperty in interface PropertyAccess
Parameters:
name - the name of the property
Returns:
the requested property or null if it's not available

getPropertyCount

public int getPropertyCount()
Returns the number of properties.

Specified by:
getPropertyCount in interface PropertyAccess
Returns:
the number of properties in this metadata object.

iterator

public java.util.Iterator iterator()
Returns an Iterator over all properties in this structured property.

Specified by:
iterator in interface PropertyAccess
Returns:
an Iterator over all properties

toSAX

public void toSAX(org.xml.sax.ContentHandler handler)
           throws org.xml.sax.SAXException
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

toString

public java.lang.String toString()

Overrides:
toString in class java.lang.Object

xmlgraphics-commons 1.3

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