Class XMPProperty

java.lang.Object
org.apache.xmlgraphics.xmp.XMPProperty
All Implemented Interfaces:
XMLizable

public class XMPProperty extends Object implements XMLizable
This class is the base class for all XMP properties.
  • Field Details

    • attribute

      protected boolean attribute
  • Constructor Details

    • XMPProperty

      public XMPProperty(QName name, Object value)
      Creates a new XMP property.
      Parameters:
      name - the name of the property
      value - the value for the property
  • Method Details

    • getName

      public QName getName()
      Returns:
      the qualified name of the property (namespace URI + local name)
    • getNamespace

      public String getNamespace()
      Returns:
      the namespace URI of the property
    • setValue

      public void setValue(Object value)
      Sets the value of the property
      Parameters:
      value - the new value
    • getValue

      public Object getValue()
      Returns:
      the property value (can be a normal Java object (normally a String) or a descendant of XMPComplexValue.
    • setXMLLang

      public void setXMLLang(String lang)
      Sets the xml:lang value for this property
      Parameters:
      lang - the language ("x-default" for the default language, null to make the value language-independent)
    • getXMLLang

      public String getXMLLang()
      Returns:
      the language for language-dependent values ("x-default" for the default language)
    • isArray

      public boolean isArray()
      Indicates whether the property is an array.
      Returns:
      true if the property is an array
    • getArrayValue

      public XMPArray getArrayValue()
      Returns:
      the XMPArray for an array or null if the value is not an array.
    • convertSimpleValueToArray

      public XMPArray convertSimpleValueToArray(XMPArrayType type)
      Converts a simple value to an array of a given type if the value is not already an array.
      Parameters:
      type - the desired type of array
      Returns:
      the array value
    • getStructureValue

      public PropertyAccess getStructureValue()
      Returns:
      the XMPStructure for a structure or null if the value is not a structure.
    • isQualifiedProperty

      public boolean isQualifiedProperty()
      Indicates whether this property is actually not a structure, but a normal property with property qualifiers. If this method returns true, this structure can be converted to an simple XMPProperty using the simplify() method.
      Returns:
      true if this property is a structure property with property qualifiers
    • simplify

      public void simplify()
    • toSAX

      public void toSAX(ContentHandler handler) throws 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:
      SAXException - if there's a problem generating the SAX events
      See Also:
    • toString

      public String toString()
      Overrides:
      toString in class Object
      See Also: