XmpPdfAExtensionSchema
Inheritance: java.lang.Object
public class XmpPdfAExtensionSchema
Describes the XMP extension schema which is provided by PDF/A-1.
Constructors
Constructor | Description |
---|---|
XmpPdfAExtensionSchema(XmpPdfAExtensionSchemaDescription description) | Initializes new object. |
Fields
Field | Description |
---|---|
DEFAULT_EXTENSION_NAMESPACE_PREFIX | Default extension namespace prefix. |
DEFAULT_EXTENSION_NAMESPACE_URI | Default extension namespace uri. |
DEFAULT_SCHEMA_NAMESPACE_PREFIX | Default schema namespace prefix. |
DEFAULT_SCHEMA_NAMESPACE_URI | Default schema namespace uri. |
DEFAULT_PROPERTY_NAMESPACE_PREFIX | Default property namespace prefix. |
DEFAULT_PROPERTY_NAMESPACE_URI | Default property namespace uri. |
DEFAULT_VALUE_TYPE_NAMESPACE_PREFIX | Default valie type namespace prefix. |
DEFAULT_VALUE_NAMESPACE_URI | Default value namespace uri. |
DEFAULT_FIELD_NAMESPACE_PREFIX | Default field namespace prefix. |
DEFAULT_FIELD_NAMESPACE_URI | Default extension namespace uri. |
RDF_PREFIX | Default rdf namespace prefix. |
RDF_NAMESPACE_URI | Default rdf namespace uri. |
Methods
Method | Description |
---|---|
getDescription() | Gets the schema description. |
getObjectsInternal() | Gets the list of objects (properties, value types). |
getObjects1() | Gets the list of objects (properties, value types). |
add(XmpPdfAExtensionObject obj) | Adds new object into schema. |
contains(XmpPdfAExtensionObject obj) | Determines whether obj exists in schema. |
remove(XmpPdfAExtensionObject obj) | Removes the object from schema. |
getSchemaXml(System.Xml.XmlDocument xmlDocument) | Returns the xml element (tag - li) that represents schema in xml tree. |
getValuesXml(System.Xml.XmlDocument xmlDocument, System.Xml.XmlElement rootElement) | Gets the values of properties as xml tree representation. |
getPropertyIndex(String name) | Returns index of property with given name. |
getProperty(String name) | Returns PDF/A property by its name. |
isPdfAExtensionPrefix(String localName) | Determines whether prefix value is a part of pdf-a extension. |
createSchemasElement(System.Xml.XmlNode rootNode) | Creates the list of schemas elements from xml tree. |
initializeSchemaValue(System.Xml.XmlNode node, XmpPdfAExtensionSchema schema) | Initializes the value of property. |
createDescriptionValueXml(System.Xml.XmlDocument xmlDocument) | Creates the description xml element for the block of properties values. |
createDescriptionXml(System.Xml.XmlDocument xmlDocument) | Creates the description xml element for the all schemas. |
XmpPdfAExtensionSchema(XmpPdfAExtensionSchemaDescription description)
public XmpPdfAExtensionSchema(XmpPdfAExtensionSchemaDescription description)
Initializes new object.
Parameters:
Parameter | Type | Description |
---|---|---|
description | XmpPdfAExtensionSchemaDescription | The schema description. |
DEFAULT_EXTENSION_NAMESPACE_PREFIX
public static final String DEFAULT_EXTENSION_NAMESPACE_PREFIX
Default extension namespace prefix.
DEFAULT_EXTENSION_NAMESPACE_URI
public static final String DEFAULT_EXTENSION_NAMESPACE_URI
Default extension namespace uri.
DEFAULT_SCHEMA_NAMESPACE_PREFIX
public static final String DEFAULT_SCHEMA_NAMESPACE_PREFIX
Default schema namespace prefix.
DEFAULT_SCHEMA_NAMESPACE_URI
public static final String DEFAULT_SCHEMA_NAMESPACE_URI
Default schema namespace uri.
DEFAULT_PROPERTY_NAMESPACE_PREFIX
public static final String DEFAULT_PROPERTY_NAMESPACE_PREFIX
Default property namespace prefix.
DEFAULT_PROPERTY_NAMESPACE_URI
public static final String DEFAULT_PROPERTY_NAMESPACE_URI
Default property namespace uri.
DEFAULT_VALUE_TYPE_NAMESPACE_PREFIX
public static final String DEFAULT_VALUE_TYPE_NAMESPACE_PREFIX
Default valie type namespace prefix.
DEFAULT_VALUE_NAMESPACE_URI
public static final String DEFAULT_VALUE_NAMESPACE_URI
Default value namespace uri.
DEFAULT_FIELD_NAMESPACE_PREFIX
public static final String DEFAULT_FIELD_NAMESPACE_PREFIX
Default field namespace prefix.
DEFAULT_FIELD_NAMESPACE_URI
public static final String DEFAULT_FIELD_NAMESPACE_URI
Default extension namespace uri.
RDF_PREFIX
public static final String RDF_PREFIX
Default rdf namespace prefix.
RDF_NAMESPACE_URI
public static final String RDF_NAMESPACE_URI
Default rdf namespace uri.
getDescription()
public XmpPdfAExtensionSchemaDescription getDescription()
Gets the schema description.
Returns: XmpPdfAExtensionSchemaDescription - XmpPdfAExtensionSchemaDescription
getObjectsInternal()
public System.Collections.Generic.List<XmpPdfAExtensionObject> getObjectsInternal()
Gets the list of objects (properties, value types).
Returns: com.aspose.ms.System.Collections.Generic.List<com.aspose.pdf.XmpPdfAExtensionObject> - ArrayList
getObjects1()
public List getObjects1()
Gets the list of objects (properties, value types).
Returns: java.util.List - ArrayList
add(XmpPdfAExtensionObject obj)
public void add(XmpPdfAExtensionObject obj)
Adds new object into schema.
Parameters:
Parameter | Type | Description |
---|---|---|
obj | XmpPdfAExtensionObject | The new object. |
contains(XmpPdfAExtensionObject obj)
public boolean contains(XmpPdfAExtensionObject obj)
Determines whether obj exists in schema.
Parameters:
Parameter | Type | Description |
---|---|---|
obj | XmpPdfAExtensionObject | The obj to find. |
Returns: boolean - True - object exists in schema; otherwise, false.
remove(XmpPdfAExtensionObject obj)
public void remove(XmpPdfAExtensionObject obj)
Removes the object from schema.
Parameters:
Parameter | Type | Description |
---|---|---|
obj | XmpPdfAExtensionObject | The object to remove. |
getSchemaXml(System.Xml.XmlDocument xmlDocument)
public System.Xml.XmlElement getSchemaXml(System.Xml.XmlDocument xmlDocument)
Returns the xml element (tag - li) that represents schema in xml tree.
Parameters:
Parameter | Type | Description |
---|---|---|
xmlDocument | com.aspose.ms.System.Xml.XmlDocument | The source xml document. |
Returns: com.aspose.ms.System.Xml.XmlElement - The xml element.
getValuesXml(System.Xml.XmlDocument xmlDocument, System.Xml.XmlElement rootElement)
public void getValuesXml(System.Xml.XmlDocument xmlDocument, System.Xml.XmlElement rootElement)
Gets the values of properties as xml tree representation.
Parameters:
Parameter | Type | Description |
---|---|---|
xmlDocument | com.aspose.ms.System.Xml.XmlDocument | The source xml document. |
rootElement | com.aspose.ms.System.Xml.XmlElement | The root node of properties values list. |
getPropertyIndex(String name)
public final int getPropertyIndex(String name)
Returns index of property with given name.
Parameters:
Parameter | Type | Description |
---|---|---|
name | java.lang.String | Property name. |
Returns: int - Index of property within Objects List,
getProperty(String name)
public final XmpPdfAExtensionProperty getProperty(String name)
Returns PDF/A property by its name.
Parameters:
Parameter | Type | Description |
---|---|---|
name | java.lang.String | Property name. |
Returns: XmpPdfAExtensionProperty - XmpPdfAExtensionProperty instance The property.
isPdfAExtensionPrefix(String localName)
public static boolean isPdfAExtensionPrefix(String localName)
Determines whether prefix value is a part of pdf-a extension.
Parameters:
Parameter | Type | Description |
---|---|---|
localName | java.lang.String | The prefix value to validate. |
Returns: boolean - True - prefix is a part of pdf-a extension; otherwise, false.
createSchemasElement(System.Xml.XmlNode rootNode)
public static HashDictionary<String,XmpPdfAExtensionSchema> createSchemasElement(System.Xml.XmlNode rootNode)
Creates the list of schemas elements from xml tree.
Parameters:
Parameter | Type | Description |
---|---|---|
rootNode | com.aspose.ms.System.Xml.XmlNode | The root node for schemas elements. |
Returns: HashDictionary - The dictionary of schemas elements in format (key, value): schema_prefix, schema value.
initializeSchemaValue(System.Xml.XmlNode node, XmpPdfAExtensionSchema schema)
public static void initializeSchemaValue(System.Xml.XmlNode node, XmpPdfAExtensionSchema schema)
Initializes the value of property.
Parameters:
Parameter | Type | Description |
---|---|---|
node | com.aspose.ms.System.Xml.XmlNode | The current node that stores property value. |
schema | XmpPdfAExtensionSchema | The schema that contains property definition. |
createDescriptionValueXml(System.Xml.XmlDocument xmlDocument)
public static System.Xml.XmlElement createDescriptionValueXml(System.Xml.XmlDocument xmlDocument)
Creates the description xml element for the block of properties values.
Parameters:
Parameter | Type | Description |
---|---|---|
xmlDocument | com.aspose.ms.System.Xml.XmlDocument | The source xml document. |
Returns: com.aspose.ms.System.Xml.XmlElement - The description xml element.
createDescriptionXml(System.Xml.XmlDocument xmlDocument)
public static System.Xml.XmlElement createDescriptionXml(System.Xml.XmlDocument xmlDocument)
Creates the description xml element for the all schemas.
Parameters:
Parameter | Type | Description |
---|---|---|
xmlDocument | com.aspose.ms.System.Xml.XmlDocument | The source xml document. |
Returns: com.aspose.ms.System.Xml.XmlElement - The description xml element.