|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.arsdigita.persistence.metadata.Element
com.arsdigita.persistence.metadata.Property
The Property class represents one property of a CompoundType. Each property is a "field" in the CompoundType. Every Property has an associated DataType. This allows CompoundTypes to be constructed from multiple SimpleTypes and CompoundTypes. In addition to having an associated DataType, each property has an associated multiplicity. There are currently three possible values for the multiplicity of a Property, NULLABLE, REQUIRED, and COLLECTION.
Field Summary | |
static int |
COLLECTION
The COLLECTION multiplicity is for multi valued properties. |
static int |
NULLABLE
The NULLABLE multiplicity is for single valued properties that can be set to null. |
static int |
REQUIRED
The REQUIRED multiplicity is for single valued properties that cannot be set to null. |
static String |
versionId
|
Method Summary | |
Property |
getAssociatedProperty()
Returns the associated property or null if there is no associated property. |
Association |
getAssociation()
Returns the associon that this property plays a role in, or null if this property doesn't play a role in an association. |
CompoundType |
getContainer()
Returns the container of this property. |
Class |
getJavaClass()
Returns the java class for the object that will be returned when DataObject.get() is called on this Property. |
CompoundType |
getLinkType()
Returns the type of the link object used by this association, or null if there is none. |
int |
getMultiplicity()
Returns the integer type code for the multiplicity of this property. |
String |
getName()
Returns the name of this Property. |
DataType |
getType()
Returns the type of this Property. |
boolean |
isAttribute()
Returns true if this Property is an attribute, i.e. |
boolean |
isCollection()
Returns true if the multiplicity of this Property is COLLECTION. |
boolean |
isComponent()
Returns true if this property is a component. |
boolean |
isComposite()
Returns true if this property refers to the composite of the object type containing this property. |
boolean |
isKeyProperty()
|
boolean |
isNullable()
Returns true if the multiplicity of this Property is NULLABLE. |
boolean |
isRequired()
Returns true if the multiplicity of this Property is REQUIRED. |
boolean |
isRole()
Returns true if this Property is a role, i.e. |
String |
toString()
|
Methods inherited from class com.arsdigita.persistence.metadata.Element |
equals, getColumnNumber, getFilename, getLineNumber, hashCode |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int NULLABLE
public static final int REQUIRED
public static final int COLLECTION
public static final String versionId
Method Detail |
public CompoundType getContainer()
public String getName()
public DataType getType()
public boolean isAttribute()
public boolean isRole()
public int getMultiplicity()
public boolean isCollection()
public boolean isNullable()
public boolean isRequired()
public boolean isComponent()
public Association getAssociation()
public CompoundType getLinkType()
public Property getAssociatedProperty()
public boolean isComposite()
public Class getJavaClass()
public boolean isKeyProperty()
public String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |