org.netbeans.modules.schema2beans

Interface BaseProperty

All Known Implementing Classes:

BeanProp, ReflectiveBeanProp

public interface BaseProperty

The BaseProperty interface is the public (user) view of the schema2beans property objects BeanProp. See also BaseAttribute and the BaseBean introspection methods.

Property Summary

Type	Property and Description
boolean	isChoice Gets the value of the property choiceProperty.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BaseProperty.VetoException

Field Summary

Fields

Modifier and Type	Field and Description
static int	INSTANCE_MANDATORY_ARRAY
static int	INSTANCE_MANDATORY_ELT
static int	INSTANCE_OPTIONAL_ARRAY
static int	INSTANCE_OPTIONAL_ELT Values returned by getInstanceType()

Method Summary

Modifier and Type	Method and Description
String[]	getAttributeNames() If the property has an attribute, return all the attribute names.
BaseAttribute[]	getAttributes() If the property has an attribute, return all the attributes definitions, as a list of BaseAttribute interfaces.
BaseProperty[]	getChoiceProperties() If this property is a choice property, returns all other choice properties associated to this one (including this one).
String	getDtdName() Return the dtd name of the property, as it appears in the DTD file.
String	getFullName()
String	getFullName(int index) Returns the full path name of the property (unique String name identifying the property for the lifetime of the graph).
int	getInstanceType() Returns the instanciation type of the property.
String	getName() Return the name of the property as it is used in the bean class.
BaseBean	getParent() Return the BaseBean for this property if there is one
Class	getPropertyClass() Return the class type of the property.
boolean	hasName(String name) Return true if the name is either equals to getName() or getDtdName()
boolean	isBean() Return true if the property is a bean (a node in the graph).
boolean	isChoiceProperty() Gets the value of the property choiceProperty.
boolean	isIndexed() Return true if the property is an indexed property.
boolean	isKey() Return true if this property matters when schema2beans compare graphs
boolean	isRoot() Return true if this is the root property
int	size() If the property is an indexed property, return the number of element (might contain null elements).

Property Detail

isChoice

boolean isChoiceProperty

Gets the value of the property choiceProperty.

Field Detail

INSTANCE_OPTIONAL_ELT

static final int INSTANCE_OPTIONAL_ELT

Values returned by getInstanceType()

See Also:

Constant Field Values

INSTANCE_MANDATORY_ELT

static final int INSTANCE_MANDATORY_ELT

See Also:

Constant Field Values

INSTANCE_OPTIONAL_ARRAY

static final int INSTANCE_OPTIONAL_ARRAY

See Also:

Constant Field Values

INSTANCE_MANDATORY_ARRAY

static final int INSTANCE_MANDATORY_ARRAY

See Also:

Constant Field Values

Method Detail

isRoot

boolean isRoot()

Return true if this is the root property

getParent

BaseBean getParent()

Return the BaseBean for this property if there is one

getName

String getName()

Return the name of the property as it is used in the bean class.

getDtdName

String getDtdName()

Return the dtd name of the property, as it appears in the DTD file.

getPropertyClass

Class getPropertyClass()

Return the class type of the property. If a wrapper is defined for the class, the class of the wrapper is returned instead of the java.lang.String class.

isIndexed

boolean isIndexed()

Return true if the property is an indexed property.

isBean

boolean isBean()

Return true if the property is a bean (a node in the graph). Any object of the graph which is a bean is a subclass of BaseBean.

size

int size()

If the property is an indexed property, return the number of element (might contain null elements).

getAttributeNames

String[] getAttributeNames()

If the property has an attribute, return all the attribute names. Return an empty array of there is no attribute.

getAttributes

BaseAttribute[] getAttributes()

If the property has an attribute, return all the attributes definitions, as a list of BaseAttribute interfaces. The array is empty if there is no attribute.

getFullName

String getFullName(int index)

Returns the full path name of the property (unique String name identifying the property for the lifetime of the graph).

getFullName

String getFullName()

getInstanceType

int getInstanceType()

Returns the instanciation type of the property. This might be one of the following: INSTANCE_OPTIONAL_ELT INSTANCE_MANDATORY_ELT INSTANCE_OPTIONAL_ARRAY INSTANCE_MANDATORY_ARRAY

isChoiceProperty

boolean isChoiceProperty()

Gets the value of the property choiceProperty.

getChoiceProperties

BaseProperty[] getChoiceProperties()

If this property is a choice property, returns all other choice properties associated to this one (including this one). If the current property is not a choice property, returns null.

hasName

boolean hasName(String name)

Return true if the name is either equals to getName() or getDtdName()

isKey

boolean isKey()

Return true if this property matters when schema2beans compare graphs