public class AccessorDef extends AttributeDef implements AccessorDefinition
LEAFELEMENT_HINT, LEAFELEMENT_NO_ATTRIBUTE, LEAFELEMENT_WITH_ATTRIBUTE
TYPE_ACCESSOR, TYPE_ATTRIBUTE, TYPE_CRITERIA, TYPE_CRITERIA_ITEM, TYPE_CRITERIA_OPERATOR, TYPE_CRITERIA_ROW, TYPE_DATACONTROL, TYPE_DEFINITION, TYPE_DEFINITIONCONTEXT, TYPE_NAMED, TYPE_OPERATION, TYPE_OPERATIONRETURN, TYPE_PARAMETER, TYPE_STRUCTURE, TYPE_VARIABLE
Constructor and Description |
---|
AccessorDef(java.lang.String id,
StructureDefinition parent,
boolean isCollection)
Creates a new accessor definition as a complex type.
|
AccessorDef(java.lang.String id,
StructureDefinition parent,
boolean isKey,
boolean isCollection)
Creates a new accessor definition as a complex type.
|
AccessorDef(java.lang.String id,
StructureDefinition parent,
java.lang.String type)
Creates a new accessor definition as a java type collection.
|
AccessorDef(java.lang.String id,
StructureDefinition parent,
java.lang.String type,
java.lang.String elementType)
Creates a new accessor definition as a collection of a scalar type.
|
AccessorDef(java.lang.String id,
StructureDefinition parent,
java.lang.String type,
java.lang.String elementName,
java.lang.String elementType)
Creates a new accessor definition as a collection of a scalar type.
|
AccessorDef(java.lang.String id,
StructureDefinition parent,
StructureDefinition struct,
boolean isCollection)
Creates a new accessor definition as a complex type.
|
AccessorDef(java.lang.String id,
StructureDefinition parent,
StructureDefinition struct,
boolean isCollection,
boolean isScalarCollection)
Creates a new accessor definition as a complex type.
|
Modifier and Type | Method and Description |
---|---|
AccessorDef |
clone(StructureDef parentStruct,
java.lang.String id)
Clones the accessor with a new id and a new parent.
|
boolean |
equals(java.lang.Object obj) |
StructureDefinition |
getCollectionStructure()
Retrieves the metadata of the collection itself.
|
int |
getDefinitionType()
Retrieves the type of the variable.
|
java.lang.String |
getFullName()
Returns the bind path for this accessor.
|
AccessorDefinition |
getParentAccessor()
Retrieves the AccessorDefinition of the parent accessor.
|
StructureDefinition |
getStructure()
Retrieves the metadata of the elements that the accessor collection contains.
|
boolean |
isCollection()
Since an accessor can return a structured object (or a
collection).
|
boolean |
isScalarCollection()
Returns true if the accessor returns a collection of scalars.
|
void |
setAsCollection()
Sets this accessor as a collection type.
|
void |
setCollectionStructure(StructureDefinition def)
Set the structure definition for the collection if the return is a
collection.
|
void |
setParentAccessor(AccessorDefinition parentAccessor) |
void |
setStructure(StructureDefinition struct) |
addProperties, addProperty, getBindPath, getDefinitionParent, getName, getProperties, getProperty, initPropertyMap, isPropertyMapNull, putProperty, setBindPath, setName
getSourceTypeString, isKey, isReadOnly, setReadOnly, setSourceTypeString
getDataControlDefinition, getJavaTypeString, setProperty
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getSourceTypeString, isKey, isReadOnly
getDataControlDefinition, getJavaTypeString
getDefinitionParent, getName, getProperties, getProperty
public AccessorDef(java.lang.String id, StructureDefinition parent, java.lang.String type)
id
- unique id for the definition.parent
- parent structure definition that this accessor is a part of.type
- the data type defined as a java type available for the system.public AccessorDef(java.lang.String id, StructureDefinition parent, java.lang.String type, java.lang.String elementType)
id
- unique id for the definitionparent
- parent structure definition that this accessor is a part of.type
- the data type defined as a java type available for the system.elementType
- the java type of each element in the collection.public AccessorDef(java.lang.String id, StructureDefinition parent, java.lang.String type, java.lang.String elementName, java.lang.String elementType)
id
- unique id for the definitionparent
- parent structure definition that this accessor is a part of.type
- the data type defined as a java type available for the system.elementName
- the name of element in the collection.elementType
- the java type of each element in the collection.public AccessorDef(java.lang.String id, StructureDefinition parent, StructureDefinition struct, boolean isCollection)
Accessors can be used to define the complex structure for which a java type may not be defined. For accessors that are collection of scalar types, use the constructor with the additional isScalarCollection parameter.
id
- unique id for the definition.parent
- parent structure definition that this accessor is a part of.struct
- the complex structer that describes this accessor.isCollection
- indicates if the accessor is a collection.public AccessorDef(java.lang.String id, StructureDefinition parent, StructureDefinition struct, boolean isCollection, boolean isScalarCollection)
Accessors can be used to define the complex structure for which a java type may not be defined.
id
- unique id for the definition.parent
- parent structure definition that this accessor is a part of.struct
- the complex structer that describes this accessor.isCollection
- indicates if the accessor is a collection.isScalarCollection
- indicates if the accessor is a collection of scalars.public AccessorDef(java.lang.String id, StructureDefinition parent, boolean isCollection)
Accessors can be used to define the complex structure for which a java type may not be defined.
id
- unique id for the definition.parent
- parent structure definition that this accessor is a part of.isCollection
- indicates if the accessor is a collection.public AccessorDef(java.lang.String id, StructureDefinition parent, boolean isKey, boolean isCollection)
Accessors can be used to define the complex structure for which a java type may not be defined.
id
- unique id for the definition.parent
- parent of this attribute.isKey
- flag to indicate if the accessor is a key.isCollection
- indicates if the accessor is a collection.public java.lang.String getFullName()
getFullName
in interface NamedDefinition
getFullName
in class AttributeDef
String
value. If the bind path
is set, it returns public boolean isCollection()
AccessorDefinition
isCollection
in interface AccessorDefinition
public boolean isScalarCollection()
AccessorDefinition
isScalarCollection
in interface AccessorDefinition
public StructureDefinition getStructure()
AccessorDefinition
getStructure
in interface AccessorDefinition
public StructureDefinition getCollectionStructure()
AccessorDefinition
getCollectionStructure
in interface AccessorDefinition
public AccessorDefinition getParentAccessor()
AccessorDefinition
getParentAccessor
in interface AccessorDefinition
public int getDefinitionType()
BaseValueObjectDefinition
getDefinitionType
in interface Definition
getDefinitionType
in class AttributeDef
public void setAsCollection()
public void setCollectionStructure(StructureDefinition def)
public void setStructure(StructureDefinition struct)
public void setParentAccessor(AccessorDefinition parentAccessor)
public AccessorDef clone(StructureDef parentStruct, java.lang.String id)
parentStruct
- the parent structure definition of the cloned accessor.id
- id of the new accessor.AccessorDef
value.public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object