Package org.gcube.informationsystem.types.reference.properties

Interface PropertyDefinition

All Superinterfaces:

Attribute, AttributeDefinition, Comparable<PropertyDefinition>, Element, PropertyElement, Serializable

All Known Implementing Classes:

PropertyDefinitionImpl

@TypeMetadata(name="PropertyDefinition",
              description="This type provides information for the definition of any properties",
              version="1.1.0")
@Change(version="1.1.0",description="The type comply with {@link AttributeDefinition} which add \'defaultValue\'") @Change(version="1.0.0",description="First Version")
public interface PropertyDefinition
extends PropertyElement, Comparable<PropertyDefinition>, AttributeDefinition

Defines a property of an entity or another property, including its constraints and metadata.

Author:

Luca Frosini (ISTI - CNR)

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME	The name of the PropertyDefinition type.
static String	READ_ONLY_PROPERTY	The property name for the 'readonly' flag.
static String	VERSION	The version of this type definition.

Fields inherited from interface org.gcube.informationsystem.base.reference.Attribute

DEFAULT_VALUE_PROPERTY, DESCRIPTION_PROPERTY, MAX_PROPERTY, MIN_PROPERTY, NAME_PROPERTY, PROPERTY_TYPE_PROPERTY, REGEX_PROPERTY

Fields inherited from interface org.gcube.informationsystem.base.reference.AttributeDefinition

MANDATORY_PROPERTY, NOT_NULL_PROPERTY

Fields inherited from interface org.gcube.informationsystem.base.reference.Element

DATETIME_PATTERN, TYPE_PROPERTY

Method Summary

Modifier and Type	Method	Description
Object	getDefaultValue()	Returns the default value of the attribute.
String	getDescription()	Returns the description of the attribute.
Integer	getMax()	Returns the maximum allowed value for the attribute.
Integer	getMin()	Returns the minimum allowed value for the attribute.
String	getName()	Returns the name of the attribute.
String	getPropertyType()	Returns the property type of the attribute as a string.
String	getRegexp()	Returns the regular expression used to validate the attribute's value.
boolean	isMandatory()	Checks if the attribute is mandatory.
boolean	isNotnull()	Checks if the attribute's value cannot be null.
boolean	isReadonly()	Checks if the property is read-only.
void	setReadonly(boolean readonly)	Sets whether the property is read-only.

Methods inherited from interface org.gcube.informationsystem.base.reference.Attribute

getPropertyTypeName, setDefaultValue, setDescription, setMax, setMin, setName, setPropertyType, setRegexp

Methods inherited from interface org.gcube.informationsystem.base.reference.AttributeDefinition

setMandatory, setNotnull

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.gcube.informationsystem.base.reference.Element

getTypeName

Field Detail

NAME

static final String NAME

The name of the PropertyDefinition type.

See Also:

Constant Field Values

VERSION

static final String VERSION

The version of this type definition.

See Also:

Constant Field Values

READ_ONLY_PROPERTY

static final String READ_ONLY_PROPERTY

The property name for the 'readonly' flag.

See Also:

Constant Field Values

Method Detail

getName

@ISProperty(name="name",
            readonly=true,
            mandatory=true,
            nullable=false)
String getName()

Returns the name of the attribute.

Specified by:

getName in interface Attribute

Returns:

The attribute's name.

getDescription

@ISProperty(name="description",
            readonly=false,
            mandatory=true,
            nullable=false)
String getDescription()

Returns the description of the attribute.

Specified by:

getDescription in interface Attribute

Returns:

The attribute's description.

isMandatory

@ISProperty(name="mandatory",
            readonly=false,
            mandatory=true,
            nullable=false,
            defaultValue="false")
boolean isMandatory()

Checks if the attribute is mandatory.

Specified by:

isMandatory in interface AttributeDefinition

Returns:

true if the attribute is mandatory, false otherwise.

isReadonly

@ISProperty(name="readonly",
            readonly=false,
            mandatory=true,
            nullable=false,
            defaultValue="false")
boolean isReadonly()

Checks if the property is read-only.

Returns:

true if the property is read-only, false otherwise.

setReadonly

void setReadonly(boolean readonly)

Sets whether the property is read-only.

Parameters:

readonly - true to make the property read-only.

isNotnull

@ISProperty(name="notnull",
            readonly=false,
            mandatory=true,
            nullable=false,
            defaultValue="false")
boolean isNotnull()

Checks if the attribute's value cannot be null.

Specified by:

isNotnull in interface AttributeDefinition

Returns:

true if the attribute value must not be null, false otherwise.

getMax

@ISProperty(name="max",
            readonly=false,
            mandatory=true,
            nullable=false)
Integer getMax()

Returns the maximum allowed value for the attribute.

Specified by:

getMax in interface Attribute

Returns:

The maximum value, or null if not set.

getMin

@ISProperty(name="min",
            readonly=false,
            mandatory=true,
            nullable=false)
Integer getMin()

Returns the minimum allowed value for the attribute.

Specified by:

getMin in interface Attribute

Returns:

The minimum value, or null if not set.

getRegexp

@ISProperty(name="regexp",
            readonly=false,
            mandatory=true,
            nullable=false)
String getRegexp()

Returns the regular expression used to validate the attribute's value.

Specified by:

getRegexp in interface Attribute

Returns:

The regular expression, or null if not set.

getPropertyType

@ISProperty(name="propertyType",
            readonly=false,
            mandatory=true,
            nullable=false)
String getPropertyType()

Returns the property type of the attribute as a string.

Specified by:

getPropertyType in interface Attribute

Returns:

The property type.

getDefaultValue

@ISProperty(name="defaultValue",
            readonly=false,
            mandatory=false,
            nullable=true)
Object getDefaultValue()

Returns the default value of the attribute.

Specified by:

getDefaultValue in interface Attribute

Returns:

The default value.