de.ipcon.schema

Class AttributeTemplate

java.lang.Object

de.ipcon.schema.AttributeTemplate

All Implemented Interfaces:

AttributeWithUIConfigurationI, BasicAttributeI, java.lang.Comparable<java.lang.Object>

public class AttributeTemplate
extends java.lang.Object
implements AttributeWithUIConfigurationI

class representing the parsed attribute elements from the definition of a schema-defined interface. Only basic information about attributes is required and taken, as the interface merely declares common accessors (methods declarations) for the attributes, but mustn't define implementation details or handling in the database.

Constructor Summary

Constructors

Constructor and Description
AttributeTemplate(SchemaInterfaceI interfaceI, electric.xml.Element xml)

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object o)
java.lang.String	getComment()
java.lang.String	getContainingElementName()
java.lang.String	getContainingElementPackage()
int	getEditmode()
int	getExpectedWidth()
java.util.Map<java.lang.String,java.lang.String>	getGuiTips()
java.lang.String	getItemProperty()
java.lang.String	getName()
EntityI	getRelationEntity()
java.lang.String	getRelationType()
java.lang.String	getSelectionFilter()
java.lang.String	getSingular()
java.lang.String	getTimeZoneProperty()
CBOAttributeTypeI	getType()
java.lang.String	getTypeName() Returns the type information of this attribute.
electric.xml.Element	getXML()
boolean	hasCustomIterator() Returns true if this AttributeI is a relation that uses a custom iterator to fetch its members incrementally.
boolean	isAutotrim()
boolean	isCreateInDetailView()
boolean	isMandatory()
boolean	isManyRelation()
boolean	isReadonly() Returns whether this AttributeI instance is strictly read-only.
boolean	isRelation()
boolean	isVirtual()
boolean	isVisible()
void	setAutotrim(boolean autotrim)
void	setCreateInDetailView(boolean createInDetailView)
void	setEditable(boolean editable)
void	setEditmode(int editmode)
void	setExpectedWidth(int expectedWidth)
void	setGuiTips(java.util.Map<java.lang.String,java.lang.String> guiTips)
void	setItemProperty(java.lang.String itemProperty)
void	setMandatory(boolean mandatory)
void	setRelationEntity(EntityI entity)
void	setSelectionFilter(java.lang.String selectionFilter)
void	setTimeZoneProperty(java.lang.String timeZoneProperty)
void	setVisible(boolean visible)

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.ipcon.schema.BasicAttributeI

getClazz, isArray

Constructor Detail

AttributeTemplate

public AttributeTemplate(SchemaInterfaceI interfaceI,
                         electric.xml.Element xml)

Method Detail

setRelationEntity

public void setRelationEntity(EntityI entity)

getXML

public electric.xml.Element getXML()

getContainingElementName

public java.lang.String getContainingElementName()

Specified by:

getContainingElementName in interface BasicAttributeI

getContainingElementPackage

public java.lang.String getContainingElementPackage()

Specified by:

getContainingElementPackage in interface BasicAttributeI

getName

public java.lang.String getName()

Specified by:

getName in interface BasicAttributeI

getComment

public java.lang.String getComment()

Specified by:

getComment in interface BasicAttributeI

getType

public CBOAttributeTypeI getType()

Specified by:

getType in interface BasicAttributeI

getTypeName

public java.lang.String getTypeName()

Description copied from interface: BasicAttributeI

Returns the type information of this attribute.

For relations, this is either the simple or qualified name of the referenced entity. For scalars, this is the declared type in the schema.

Specified by:

getTypeName in interface BasicAttributeI

Returns:

The type or relation information of this attribute.

getSingular

public java.lang.String getSingular()

Specified by:

getSingular in interface BasicAttributeI

isRelation

public boolean isRelation()

Specified by:

isRelation in interface BasicAttributeI

isManyRelation

public boolean isManyRelation()

Specified by:

isManyRelation in interface BasicAttributeI

getRelationEntity

public EntityI getRelationEntity()

Specified by:

getRelationEntity in interface BasicAttributeI

getRelationType

public java.lang.String getRelationType()

Specified by:

getRelationType in interface BasicAttributeI

Returns:

the relation type String, either SchemaI.RELATION_TYPE_N_1, SchemaI.RELATION_TYPE_1_N or SchemaI.RELATION_TYPE_N_M. The empty String (or null?) for scalars.

hasCustomIterator

public boolean hasCustomIterator()

Description copied from interface: BasicAttributeI

Returns true if this AttributeI is a relation that uses a custom iterator to fetch its members incrementally.

Specified by:

hasCustomIterator in interface BasicAttributeI

isVirtual

public boolean isVirtual()

Specified by:

isVirtual in interface BasicAttributeI

isReadonly

public boolean isReadonly()

Description copied from interface: BasicAttributeI

Returns whether this AttributeI instance is strictly read-only. An attribute that is strictly read-only cannot be modified under any circumstances. If this method returns true, any attempt to modify the attribute will result in an exception being thrown.

Specified by:

isReadonly in interface BasicAttributeI

Returns:

true if this AttributeI is strictly read-only, false otherwise.

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable<java.lang.Object>

setEditmode

public void setEditmode(int editmode)

Specified by:

setEditmode in interface AttributeWithUIConfigurationI

getEditmode

public int getEditmode()

Specified by:

getEditmode in interface AttributeWithUIConfigurationI

setCreateInDetailView

public void setCreateInDetailView(boolean createInDetailView)

Specified by:

setCreateInDetailView in interface AttributeWithUIConfigurationI

isCreateInDetailView

public boolean isCreateInDetailView()

Specified by:

isCreateInDetailView in interface AttributeWithUIConfigurationI

setItemProperty

public void setItemProperty(java.lang.String itemProperty)

Specified by:

setItemProperty in interface AttributeWithUIConfigurationI

getItemProperty

public java.lang.String getItemProperty()

Specified by:

getItemProperty in interface AttributeWithUIConfigurationI

setMandatory

public void setMandatory(boolean mandatory)

Specified by:

setMandatory in interface AttributeWithUIConfigurationI

isMandatory

public boolean isMandatory()

Specified by:

isMandatory in interface AttributeWithUIConfigurationI

setGuiTips

public void setGuiTips(java.util.Map<java.lang.String,java.lang.String> guiTips)

Specified by:

setGuiTips in interface AttributeWithUIConfigurationI

getGuiTips

public java.util.Map<java.lang.String,java.lang.String> getGuiTips()

Specified by:

getGuiTips in interface AttributeWithUIConfigurationI

setVisible

public void setVisible(boolean visible)

Specified by:

setVisible in interface AttributeWithUIConfigurationI

isVisible

public boolean isVisible()

Specified by:

isVisible in interface AttributeWithUIConfigurationI

setExpectedWidth

public void setExpectedWidth(int expectedWidth)

Specified by:

setExpectedWidth in interface AttributeWithUIConfigurationI

getExpectedWidth

public int getExpectedWidth()

Specified by:

getExpectedWidth in interface AttributeWithUIConfigurationI

setSelectionFilter

public void setSelectionFilter(java.lang.String selectionFilter)

Specified by:

setSelectionFilter in interface AttributeWithUIConfigurationI

getSelectionFilter

public java.lang.String getSelectionFilter()

Specified by:

getSelectionFilter in interface AttributeWithUIConfigurationI

setEditable

public void setEditable(boolean editable)

Specified by:

setEditable in interface AttributeWithUIConfigurationI

setAutotrim

public void setAutotrim(boolean autotrim)

Specified by:

setAutotrim in interface AttributeWithUIConfigurationI

isAutotrim

public boolean isAutotrim()

Specified by:

isAutotrim in interface AttributeWithUIConfigurationI

setTimeZoneProperty

public void setTimeZoneProperty(java.lang.String timeZoneProperty)

Specified by:

setTimeZoneProperty in interface AttributeWithUIConfigurationI

getTimeZoneProperty

public java.lang.String getTimeZoneProperty()

Specified by:

getTimeZoneProperty in interface AttributeWithUIConfigurationI