com.adobe.xmp.schema.rng.model

Class PropertyInfo

java.lang.Object

com.adobe.xmp.schema.rng.model.PropertyInfo

All Implemented Interfaces:

PropertyAnnotationInfo

public class PropertyInfo
extends Object
implements PropertyAnnotationInfo

This class holds relevant data for constructing a PropertyDescription object collected from parsing the RelaxNG schema.

Constructor Summary

Constructors

Constructor and Description
PropertyInfo(String ns, String name, SchemaInfo schemaInfo) Constructs a new PropertyInfo.

Method Summary

Modifier and Type	Method and Description
void	addChild(PropertyInfo child) Adds a child, which could either be a property qualifier, array item qualifier or a struct field
com.adobe.xmp.schema.rng.parser.annotation.RNGDecorationAnnotation.ACCESS	getAccess()
ArrayType.ArrayForm	getArrayForm()
com.adobe.xmp.schema.rng.parser.annotation.RNGDecorationAnnotation.CHOICE	getChoice()
DatatypeInfo	getDataType()
Map<String,String>	getDecorator(QName qname) Gets decorator map for given QName.
HashMap<QName,Map<String,String>>	getDecoratorStore() Gets the decorator store for this PropertyInfo
String	getDescription()
Stack<PropertyInfo>	getFields()
String	getLabel()
String	getName()
String	getNS()
ParamInfoGroup	getParamInfos()
Stack<PropertyInfo>	getQualifiers()
DatatypeInfo	getRawDataType()
SchemaInfo	getSchemaInfo()
boolean	hasDecorators() Returns if this property has decorators
boolean	isArrayItemQualifier() Gets if the propertyInfo holds information for an array item qualifier.
boolean	isDeprecated()
boolean	isMandatory()
boolean	isQualifier()
void	setAccess(com.adobe.xmp.schema.rng.parser.annotation.RNGDecorationAnnotation.ACCESS mAccess)
void	setArrayForm(ArrayType.ArrayForm form)
void	setChoice(com.adobe.xmp.schema.rng.parser.annotation.RNGDecorationAnnotation.CHOICE choice)
void	setDataType(DatatypeInfo mDataType)
void	setDeprecated(boolean mDeprecated)
void	setDescription(String mDescription)
void	setIsArrayItemQualifier(boolean isArrayItemQualifier) Sets if this propertyInfo stores information for an array item qualifier.
void	setIsQualifier(boolean isQualifier)
void	setLabel(String mLabel)
void	setMandatory(boolean mMandatory)
void	setName(String mName)
void	setNS(String mNS)
void	setParamInfos(ParamInfoGroup mParamInfos)
void	setRawDataType(DatatypeInfo mRawDataType)
void	setSchemaInfo(SchemaInfo mSchemaInfo)
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PropertyInfo

public PropertyInfo(String ns,
                    String name,
                    SchemaInfo schemaInfo)

Constructs a new PropertyInfo.

Parameters:

ns - Namespace of the property

name - Name of the property

schemaInfo - SchemaInfo object, which stores information retrieved from annotations about the XMP schema

Method Detail

addChild

public void addChild(PropertyInfo child)

Adds a child, which could either be a property qualifier, array item qualifier or a struct field

Parameters:

child - child to add

getQualifiers

public Stack<PropertyInfo> getQualifiers()

Returns:

List of qualifiers of this PropertyInfo

getFields

public Stack<PropertyInfo> getFields()

Returns:

List of fields of this PropertyInfo. Relevant only for struct property.

setNS

public void setNS(String mNS)

Parameters:

mNS - the mNS to set

getNS

public String getNS()

Returns:

the mNS

setName

public void setName(String mName)

Parameters:

mName - the mName to set

getName

public String getName()

Returns:

the mName

setParamInfos

public void setParamInfos(ParamInfoGroup mParamInfos)

Parameters:

mParamInfos - the mParamInfos to set

getParamInfos

public ParamInfoGroup getParamInfos()

Returns:

the mParamInfos

setRawDataType

public void setRawDataType(DatatypeInfo mRawDataType)

Parameters:

mRawDataType - the mRawDataType to set

getRawDataType

public DatatypeInfo getRawDataType()

Returns:

the mRawDataType

setDataType

public void setDataType(DatatypeInfo mDataType)

Parameters:

mDataType - the mDataType to set

getDataType

public DatatypeInfo getDataType()

Returns:

the mDataType

setArrayForm

public void setArrayForm(ArrayType.ArrayForm form)

Parameters:

form - the mArrayForm to set

getArrayForm

public ArrayType.ArrayForm getArrayForm()

Returns:

the mArrayForm

setLabel

public void setLabel(String mLabel)

Specified by:

setLabel in interface PropertyAnnotationInfo

Parameters:

mLabel - the mLabel to set

getLabel

public String getLabel()

Specified by:

getLabel in interface PropertyAnnotationInfo

Returns:

the mLabel

setDescription

public void setDescription(String mDescription)

Specified by:

setDescription in interface PropertyAnnotationInfo

Parameters:

mDescription - the mDescription to set

getDescription

public String getDescription()

Specified by:

getDescription in interface PropertyAnnotationInfo

Returns:

the mDescription

setAccess

public void setAccess(com.adobe.xmp.schema.rng.parser.annotation.RNGDecorationAnnotation.ACCESS mAccess)

Specified by:

setAccess in interface PropertyAnnotationInfo

Parameters:

mAccess - the mAccess to set

getAccess

public com.adobe.xmp.schema.rng.parser.annotation.RNGDecorationAnnotation.ACCESS getAccess()

Specified by:

getAccess in interface PropertyAnnotationInfo

Returns:

the mAccess

setDeprecated

public void setDeprecated(boolean mDeprecated)

Parameters:

mDeprecated - the mDeprecated to set

isDeprecated

public boolean isDeprecated()

Returns:

the mDeprecated

setMandatory

public void setMandatory(boolean mMandatory)

Parameters:

mMandatory - the mMandatory to set

isMandatory

public boolean isMandatory()

Returns:

the mMandatory

setIsArrayItemQualifier

public void setIsArrayItemQualifier(boolean isArrayItemQualifier)

Sets if this propertyInfo stores information for an array item qualifier.

Parameters:

isArrayItemQualifier - boolean

isArrayItemQualifier

public boolean isArrayItemQualifier()

Gets if the propertyInfo holds information for an array item qualifier.

Returns:

boolean

setIsQualifier

public void setIsQualifier(boolean isQualifier)

Parameters:

isQualifier - the mIsQualifier to set

isQualifier

public boolean isQualifier()

Returns:

the mIsQualifier

setSchemaInfo

public void setSchemaInfo(SchemaInfo mSchemaInfo)

Parameters:

mSchemaInfo - the mSchemaInfo to set

getSchemaInfo

public SchemaInfo getSchemaInfo()

Returns:

the mSchemaInfo

setChoice

public void setChoice(com.adobe.xmp.schema.rng.parser.annotation.RNGDecorationAnnotation.CHOICE choice)

Parameters:

choice - the choice to set

getChoice

public com.adobe.xmp.schema.rng.parser.annotation.RNGDecorationAnnotation.CHOICE getChoice()

Returns:

the choice

hasDecorators

public boolean hasDecorators()

Returns if this property has decorators

Returns:

boolean

getDecoratorStore

public HashMap<QName,Map<String,String>> getDecoratorStore()

Gets the decorator store for this PropertyInfo

Returns:

HashMap

getDecorator

public Map<String,String> getDecorator(QName qname)

Gets decorator map for given QName. If entry does not exist for the given qname, an entry is created in the decoratorstore.

Parameters:

qname - qname

Returns:

Map

toString

public String toString()

Overrides:

toString in class Object