Package it.uniroma2.art.semanticturkey.properties.dynamic

Class DynamicSTProperties

java.lang.Object

it.uniroma2.art.semanticturkey.properties.dynamic.DynamicSTProperties

All Implemented Interfaces:

STProperties

public class DynamicSTProperties
extends Object
implements STProperties

An STProperties which can be defined at runtime. Differently from ordinary STProperties implementations that define their content as Java fields, this class allows to define the allowed properties at runtime via an API.

Author:

Manuel Fiorelli

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DynamicSTProperties.AnnotatedTypeBuilder
static interface	DynamicSTProperties.Buildable
static class	DynamicSTProperties.PropertyDefinition

Nested classes/interfaces inherited from interface it.uniroma2.art.semanticturkey.properties.STProperties

STProperties.BasicPropertiesConstraints, STProperties.BasicPropertyConstraintValidator

Constructor Summary

Constructors

Constructor	Description
DynamicSTProperties()
DynamicSTProperties(String shortName)

Method Summary

Modifier and Type	Method	Description
void	addProperty(String id, DynamicSTProperties.PropertyDefinition def)
Annotation[]	getAnnotations(String id)	Returns the annotations (if any) associated with the property with given id.
Optional<EnumerationDescription>	getEnumeration(String id)	Returns the enumeration (if any) associated with the property with given id.
String	getHTMLDescription()	An optional HTML description of this type of propertySet
String	getHTMLWarning()	An optional HTML warning related to this type of propertySet
Collection<String>	getProperties()	returns all the properties of the class implementing this interface, which have been annotated as STProperty
AnnotatedType	getPropertyAnnotatedType(String id)
String	getPropertyContentType(String id)	get the expected type of content for the property.
DynamicSTProperties.PropertyDefinition	getPropertyDefinition(String id)
protected org.apache.commons.lang3.tuple.Pair<DynamicSTProperties.PropertyDefinition,Object>	getPropertyDefinitionAndValue(String id)
String	getPropertyDescription(String id)	this method returns the description of a property
String	getPropertyDisplayName(String id)	this method returns the displayName of a property.
Object	getPropertyValue(String id)	gets the value of a property previously set on this set of properties
String	getShortName()
boolean	hasRequiredProperties()	tells if this set of properties needs to be explicitly set by the user or if it can be used in its default settings
boolean	isRequiredProperty(String id)
void	removeProperty(String id)
void	setHtmlDescription(String htmlDescription)
void	setHtmlWarning(String htmlWarning)
void	setPropertyValue(String id, Object value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface it.uniroma2.art.semanticturkey.properties.STProperties

checkAndConvertPropertyValue, convertToPropertValue, getPropertyType, getStringRepresentation, isEnumerated, loadProperties, setProperties, storeProperties, storeProperties

Constructor Details

DynamicSTProperties

public DynamicSTProperties(String shortName)

DynamicSTProperties

public DynamicSTProperties()

Method Details

getPropertyDefinitionAndValue

protected org.apache.commons.lang3.tuple.Pair<DynamicSTProperties.PropertyDefinition,Object> getPropertyDefinitionAndValue(String id)
                                                                                                                    throws PropertyNotFoundException

Throws:

PropertyNotFoundException

addProperty

public void addProperty(String id,
 DynamicSTProperties.PropertyDefinition def)

removeProperty

public void removeProperty(String id)

getPropertyDefinition

public DynamicSTProperties.PropertyDefinition getPropertyDefinition(String id)
                                                             throws PropertyNotFoundException

Throws:

PropertyNotFoundException

getShortName

public String getShortName()

Specified by:

getShortName in interface STProperties

Returns:

a humanly understandable short name representing the type of this property set

setHtmlDescription

public void setHtmlDescription(String htmlDescription)

getHTMLDescription

@Nullable
public String getHTMLDescription()

Description copied from interface: STProperties

An optional HTML description of this type of propertySet

Specified by:

getHTMLDescription in interface STProperties

Returns:

an HTML description of this type of propertySet. It may be null, if no description is available

setHtmlWarning

public void setHtmlWarning(String htmlWarning)

getHTMLWarning

@Nullable
public String getHTMLWarning()

Description copied from interface: STProperties

An optional HTML warning related to this type of propertySet

Specified by:

getHTMLWarning in interface STProperties

Returns:

An optional HTML warning related to this type of propertySet. It may be null, if no warning is available

getProperties

public Collection<String> getProperties()

Description copied from interface: STProperties

returns all the properties of the class implementing this interface, which have been annotated as STProperty

Specified by:

getProperties in interface STProperties

Returns:

getPropertyAnnotatedType

public AnnotatedType getPropertyAnnotatedType(String id)
                                       throws PropertyNotFoundException

Specified by:

getPropertyAnnotatedType in interface STProperties

Throws:

PropertyNotFoundException

getPropertyContentType

public String getPropertyContentType(String id)
                              throws PropertyNotFoundException

Description copied from interface: STProperties

get the expected type of content for the property. Can be used by external tools to drive the acquisition of that value or to check

Specified by:

getPropertyContentType in interface STProperties

Returns:

Throws:

PropertyNotFoundException

getPropertyDescription

public String getPropertyDescription(String id)
                              throws PropertyNotFoundException

Description copied from interface: STProperties

this method returns the description of a property

Specified by:

getPropertyDescription in interface STProperties

Returns:

Throws:

PropertyNotFoundException

getPropertyDisplayName

public String getPropertyDisplayName(String id)
                              throws PropertyNotFoundException

Description copied from interface: STProperties

this method returns the displayName of a property. If not provided, return the property name

Specified by:

getPropertyDisplayName in interface STProperties

Returns:

Throws:

PropertyNotFoundException

getEnumeration

public Optional<EnumerationDescription> getEnumeration(String id)
                                                throws PropertyNotFoundException

Description copied from interface: STProperties

Returns the enumeration (if any) associated with the property with given id.

Specified by:

getEnumeration in interface STProperties

Returns:

Throws:

PropertyNotFoundException

getPropertyValue

public Object getPropertyValue(String id)
                        throws PropertyNotFoundException

Description copied from interface: STProperties

gets the value of a property previously set on this set of properties

Specified by:

getPropertyValue in interface STProperties

Returns:

Throws:

PropertyNotFoundException

setPropertyValue

public void setPropertyValue(String id,
 Object value)
                      throws WrongPropertiesException

Specified by:

setPropertyValue in interface STProperties

Throws:

WrongPropertiesException

isRequiredProperty

public boolean isRequiredProperty(String id)
                           throws PropertyNotFoundException

Specified by:

isRequiredProperty in interface STProperties

Throws:

PropertyNotFoundException

hasRequiredProperties

public boolean hasRequiredProperties()

Description copied from interface: STProperties

tells if this set of properties needs to be explicitly set by the user or if it can be used in its default settings

Specified by:

hasRequiredProperties in interface STProperties

Returns:

getAnnotations

public Annotation[] getAnnotations(String id)
                            throws PropertyNotFoundException

Description copied from interface: STProperties

Returns the annotations (if any) associated with the property with given id.

Specified by:

getAnnotations in interface STProperties

Returns:

Throws:

PropertyNotFoundException