public interface PropertyDescription
extends java.io.Serializable
SchemaDescription
as top-level property or or in an StructType
as a struct field.Modifier and Type | Method and Description |
---|---|
void |
accept(SchemaVisitor schemaVisitor) |
void |
addQualifier(PropertyDescription qualifier)
Add a qualifier to the property.
|
java.util.Map<java.lang.String,java.lang.String> |
getDecorator(java.lang.String namespaceURI,
java.lang.String localName)
Gets a user defined decorator map.
|
java.util.Set<javax.xml.namespace.QName> |
getDecoratorSet()
Retrieves a list of all decorators, sorted by QName.
|
java.lang.String |
getDescription() |
java.lang.String |
getLabel() |
java.lang.String |
getName() |
java.lang.String |
getNamespaceURI()
The namespace URI of the property.
|
PropertyDescription |
getQualifier(java.lang.String namespaceURI,
java.lang.String localName)
Gets a qualifier by namespace and local name if existing.
|
java.util.List<PropertyDescription> |
getQualifiers() |
PropertyType |
getType() |
boolean |
hasDecorator(java.lang.String myNamespace,
java.lang.String myDecorator)
Request if a decorator exists AND contains at least one property.
|
boolean |
hasDecorators() |
boolean |
hasQualifiers() |
boolean |
isDeprecated()
Denotes that this property shall not be used anymore,
while it is still accepted.
|
boolean |
isMandatory()
The mandatory flag denotes that a property has to be specified in an XMP data object.
|
boolean |
isReadOnly()
Read-only is a hint for UI generators and indicate that the property should not be modified
by the user, and is rather maintained by the application.
|
void |
removeDecoratorNS(java.lang.String namespaceURI)
Removes all decorators from one namespace.
|
void |
removeQualifier(java.lang.String namespaceURI,
java.lang.String localName)
Removes a qualifier by namespace and local name.
|
void |
replaceType(PropertyType finalType)
Replaces an UnspecifiedType with a final PropertyType.
|
void |
setDeprecated(boolean deprecated) |
void |
setDescription(java.lang.String description) |
void |
setLabel(java.lang.String label) |
void |
setMandatory(boolean mandatory) |
void |
setNamespaceURI(java.lang.String namespaceURI) |
void |
setReadOnly(boolean readOnly) |
java.lang.String getNamespaceURI()
void setNamespaceURI(java.lang.String namespaceURI)
namespaceURI
- the namespace to setjava.lang.String getName()
PropertyType getType()
void replaceType(PropertyType finalType)
finalType
- the type that replaces the unspecified type.void addQualifier(PropertyDescription qualifier)
qualifier
- the qualifier to add.PropertyDescription getQualifier(java.lang.String namespaceURI, java.lang.String localName)
namespaceURI
- the qualifier's namespacelocalName
- the qualifier's local namenull
if not existing.java.util.List<PropertyDescription> getQualifiers()
void removeQualifier(java.lang.String namespaceURI, java.lang.String localName)
namespaceURI
- the qualifier's namespacelocalName
- the qualifier's local nameboolean hasQualifiers()
boolean isMandatory()
void setMandatory(boolean mandatory)
mandatory
- the mandatory flag to setboolean isDeprecated()
void setDeprecated(boolean deprecated)
deprecated
- the deprecated flag to setjava.lang.String getLabel()
void setLabel(java.lang.String label)
label
- Sets the default labeljava.lang.String getDescription()
void setDescription(java.lang.String description)
description
- Sets the default descriptionboolean isReadOnly()
void setReadOnly(boolean readOnly)
readOnly
- Sets the readonly flagvoid accept(SchemaVisitor schemaVisitor) throws XMPSchemaException
schemaVisitor
- a visitor that implements the SchemaVisitor
-interfaceXMPSchemaException
java.util.Map<java.lang.String,java.lang.String> getDecorator(java.lang.String namespaceURI, java.lang.String localName)
namespaceURI
- namespace for the decorator taglocalName
- name of the decorator tagnull
.boolean hasDecorator(java.lang.String myNamespace, java.lang.String myDecorator)
namespaceURI
- namespace for the decorator taglocalName
- name of the decorator tagboolean hasDecorators()
java.util.Set<javax.xml.namespace.QName> getDecoratorSet()
getDecorator(String, String)
.void removeDecoratorNS(java.lang.String namespaceURI)
namespaceURI
- a decorator namespace URICopyright © 2010 - 2020 Adobe. All Rights Reserved