Interface EnumStringProperty
- All Superinterfaces:
org.gcube.informationsystem.base.reference.Element,GCubeProperty,org.gcube.informationsystem.model.reference.ModelElement,org.gcube.informationsystem.model.reference.properties.Property,org.gcube.informationsystem.base.reference.properties.PropertyElement,org.gcube.informationsystem.base.reference.SchemaMixedElement,Serializable,TypedProperty<Set<String>,,String> ValidatedTypedProperty<Set<String>,String>
- All Known Implementing Classes:
EnumStringPropertyImpl
@TypeMetadata(name="EnumStringProperty",
description="EnumStringProperty is a string property validated against a set of accepted values.",
version="1.1.0")
@Change(version="1.1.0",description="Declared the \'value\' and \'schema\' properties.") @Change(version="1.0.0",description="First Version")
public interface EnumStringProperty
extends GCubeProperty, ValidatedTypedProperty<Set<String>,String>
EnumStringProperty is a string property validated against a set of accepted
values.
- Author:
- Manuele Simi (ISTI - CNR), Luca Frosini (ISTI - CNR)
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe name associated with this propertystatic final StringThe version of this type definition.Fields inherited from interface org.gcube.informationsystem.base.reference.Element
DATETIME_PATTERN, REDACTED, TYPE_PROPERTY, UNKNOWN_USERFields inherited from interface org.gcube.informationsystem.model.reference.ModelElement
EXPECTED_TYPE_PROPERTY, SUPERTYPES_PROPERTY -
Method Summary
Modifier and TypeMethodDescriptionstatic EnumStringPropertyReturns a default instance of EnumStringPropertyGets the schema of the property.getValue()Gets the value of the property.voidSets the schema of the property.voidSets the value of the property.default Validationvalidate()Applies this validation to the property.Methods inherited from interface org.gcube.informationsystem.base.reference.Element
getTypeNameMethods inherited from interface org.gcube.informationsystem.model.reference.ModelElement
getExpectedType, getSupertypesMethods inherited from interface org.gcube.informationsystem.model.reference.properties.Property
getAdditionalProperties, getAdditionalProperty, setAdditionalProperties, setAdditionalProperty
-
Field Details
-
NAME
The name associated with this property- See Also:
-
VERSION
The version of this type definition.- See Also:
-
-
Method Details
-
getValue
Gets the value of the property.- Specified by:
getValuein interfaceTypedProperty<Set<String>,String> - Returns:
- the value
-
setValue
Sets the value of the property.- Specified by:
setValuein interfaceTypedProperty<Set<String>,String> - Parameters:
value- the new value
-
getSchema
Gets the schema of the property.- Specified by:
getSchemain interfaceTypedProperty<Set<String>,String> - Returns:
- the schema
-
setSchema
Sets the schema of the property.- Specified by:
setSchemain interfaceTypedProperty<Set<String>,String> - Parameters:
schema- the new schema
-
getDefaultInstance
Returns a default instance of EnumStringProperty- Returns:
- a default instance of EnumStringProperty
-
validate
Applies this validation to the property.- Specified by:
validatein interfaceValidatedTypedProperty<Set<String>,String> - Returns:
- the validation result
-