Package com.adobe.xmp.schema.model
Interface PropertyType
-
- All Superinterfaces:
java.io.Serializable
- All Known Subinterfaces:
ArrayType,SimpleType,StructType,UnspecifiedType
public interface PropertyType extends java.io.SerializableThe base interface for all XMP property types, which areSimpleType(describes simple properties),ArrayType(describes array properties),StructType(describes struct properties),UnspecifiedType(this is only used during schema parsing)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaccept(SchemaVisitor schemaVisitor)java.lang.StringgetDescription()java.lang.StringgetLabel()java.lang.StringgetName()The name of the property type is optional.TypeRulegetRule()voidsetDescription(java.lang.String description)voidsetLabel(java.lang.String label)voidsetName(java.lang.String name)voidsetRule(TypeRule rule)Add the root rule of a logic tree.
-
-
-
Method Detail
-
getName
java.lang.String getName()
The name of the property type is optional. It is only used to register it in theTypeRegistryso that it can be re-used. Names are also used to point to the core XMP types, that are defined in the specifications and are available as include files for RelaxNG.- Returns:
- Returns the name of the type.
-
setName
void setName(java.lang.String name)
- Parameters:
name- the type name to set.
-
getLabel
java.lang.String getLabel()
- Returns:
- Returns the default label of the property type in English.
-
setLabel
void setLabel(java.lang.String label)
- Parameters:
label- the default label to set
-
getDescription
java.lang.String getDescription()
- Returns:
- Returns the default description of the property type in English.
-
setDescription
void setDescription(java.lang.String description)
- Parameters:
description- the default description to set
-
getRule
TypeRule getRule()
- Returns:
- Returns the rule that constrain this array. This rule can be the root of a logic tree.
-
setRule
void setRule(TypeRule rule)
Add the root rule of a logic tree. There are restrictions on the rules allowed depending on the data type.- Parameters:
rule- the rule to add
-
accept
void accept(SchemaVisitor schemaVisitor) throws XMPSchemaException
- Parameters:
schemaVisitor- a visitor that implements theSchemaVisitor-interface- Throws:
XMPSchemaException- Handles visitor exceptions
-
-