de.ipcon.schema

Interface BasicAttributeI

All Superinterfaces:

java.lang.Comparable<java.lang.Object>

All Known Subinterfaces:

AttributeI, AttributeWithUIConfigurationI, CBOAttributeI, InstrumentingAttributeI

All Known Implementing Classes:

AttributeTemplate, AttributeWrapper, CBOAttribute, InstrumentingAttribute, ScriptedAttribute

public interface BasicAttributeI
extends java.lang.Comparable<java.lang.Object>

represents a more "basic" variant of AttributeI that contains only as much information as is needed to generate method / field declarations for an attribute.

Method Summary

Modifier and Type	Method and Description
default java.lang.Class<?>	getClazz() Returns the Class object representing the type of this attribute or the related entity.
java.lang.String	getComment()
java.lang.String	getContainingElementName()
java.lang.String	getContainingElementPackage()
java.lang.String	getName()
EntityI	getRelationEntity()
java.lang.String	getRelationType()
java.lang.String	getSingular()
CBOAttributeTypeI	getType()
java.lang.String	getTypeName() Returns the type information of this attribute.
boolean	hasCustomIterator() Returns true if this AttributeI is a relation that uses a custom iterator to fetch its members incrementally.
default boolean	isArray()
boolean	isManyRelation()
boolean	isReadonly() Returns whether this AttributeI instance is strictly read-only.
boolean	isRelation()
boolean	isVirtual()

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getName

java.lang.String getName()

getContainingElementName

java.lang.String getContainingElementName()

getContainingElementPackage

java.lang.String getContainingElementPackage()

getComment

java.lang.String getComment()

getType

CBOAttributeTypeI getType()

getTypeName

java.lang.String getTypeName()

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.

Returns:

The type or relation information of this attribute.

getSingular

java.lang.String getSingular()

getClazz

default java.lang.Class<?> getClazz()

Returns the Class object representing the type of this attribute or the related entity.

If this attribute is a relation to another entity, the method returns the Class object of the related entity. Otherwise, it returns the Class object of the attribute's declared type.

Returns:

The Class object representing the type of this attribute or the related entity.

isRelation

boolean isRelation()

isManyRelation

boolean isManyRelation()

getRelationEntity

EntityI getRelationEntity()

getRelationType

java.lang.String getRelationType()

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.

isArray

default boolean isArray()

Returns:

true if the clazz of this attribute is an array, false otherwise

hasCustomIterator

boolean hasCustomIterator()

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

isVirtual

boolean isVirtual()

isReadonly

boolean isReadonly()

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.

Returns:

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