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="Defines a property of an entity or another property, including its name, type, cardinality (min/max), regex, readonly/mandatory constraints, and default value.",
              version="2.0.0")
@Change(version="2.0.0",description="Removed \'notnull\': a null value means the same as an absent one, and \'mandatory\' means present with a real value. \'min\' and \'max\' are optional, and admit a decimal number when the property is a Double or a Float; \'regexp\' is always present, empty for no pattern.") @Change(version="1.1.0",description="The type comply with [AttributeDefinition](type: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)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	PropertyDefinition.PropertyAttribute	Documents the fixed, schema-level attributes every property field carries in a Type Schema -- a glossary of the schema language itself, not a specific property's actual value (that is what PropertyDefinition's own getters return).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	The name of the PropertyDefinition type.
static final String	READ_ONLY_PROPERTY	The property name for the 'readonly' flag.
static final Map<String,String>	SYSTEM_FIELD_GETTERS	The system field names, each with the getter the model declares for that field.
static final 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

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

DATETIME_PATTERN, REDACTED, TYPE_PROPERTY, UNKNOWN_USER

Method Summary

Modifier and Type	Method	Description
Object	getDefaultValue()	Returns the default value of the attribute.
String	getDescription()	Returns the description of the attribute.
Number	getMax()	Returns the upper bound of the property value.
Number	getMin()	Returns the lower bound of the property value.
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	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

Methods inherited from interface java.lang.Comparable

compareTo

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

getTypeName

Field Details

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

SYSTEM_FIELD_GETTERS

static final Map<String,String> SYSTEM_FIELD_GETTERS

The system field names, each with the getter the model declares for that field. A property takes a system field name only to describe that very field, on that getter: any other property with one of these names would share its JSON key with the system field.

READ_ONLY_PROPERTY

static final String READ_ONLY_PROPERTY

The property name for the 'readonly' flag.

See Also:

• Constant Field Values

Method Details

getName

@ISProperty(name="name",
            readonly=true,
            mandatory=true)
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)
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,
            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,
            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.

getMax

@ISProperty(name="max",
            description="The upper bound of the property value: an integer, or a decimal number when the property is a Double or a Float.",
            type=java.lang.Object.class,
            readonly=false,
            mandatory=false)
Number getMax()

Returns the upper bound of the property value.

A decimal number is admitted only when the base type of the property is Double or Float; for every other base type the bound is an integer.

Specified by:

getMax in interface Attribute

Returns:

The upper bound, or null if not set.

getMin

@ISProperty(name="min",
            description="The lower bound of the property value: an integer, or a decimal number when the property is a Double or a Float.",
            type=java.lang.Object.class,
            readonly=false,
            mandatory=false)
Number getMin()

Returns the lower bound of the property value.

A decimal number is admitted only when the base type of the property is Double or Float; for every other base type the bound is an integer.

Specified by:

getMin in interface Attribute

Returns:

The lower bound, or null if not set.

getRegexp

@ISProperty(name="regexp",
            readonly=false,
            mandatory=true,
            defaultValue="")
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)
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)
Object getDefaultValue()

Returns the default value of the attribute.

Specified by:

getDefaultValue in interface Attribute

Returns:

The default value.