Package it.uniroma2.art.semanticturkey.properties

Class STPropertiesImpl

java.lang.Object

it.uniroma2.art.semanticturkey.properties.STPropertiesImpl

All Implemented Interfaces:

STProperties

Direct Known Subclasses:

AbstractPluginConfiguration

public abstract class STPropertiesImpl
extends Object
implements STProperties

Nested Class Summary

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

STProperties.BasicPropertiesConstraints, STProperties.BasicPropertyConstraintValidator

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	STPropertiesImpl()
protected	STPropertiesImpl(File propertyFile)

Method Summary

Modifier and Type	Method	Description
Object	convertToPropertValue(Field prop, Object value)
Optional<EnumerationDescription>	getEnumeration(String id)	Returns the enumeration (if any) associated with the property with given id.
Collection<String>	getProperties()	returns all the properties of the class implementing this interface, which have been annotated as STProperty
String	getPropertyContentType(String parID)	get the expected type of content for the property.
String	getPropertyDescription(String id)	this method returns the description of a property
Object	getPropertyValue(String id)	gets the value of a property previously set on this set of properties
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	isEnumerated(String id)	Tells if the property with given id is enumerated: either its type is an enum (see STProperties.getPropertyType(String)) or it is annotated with Enumeration.
boolean	isRequiredProperty(String parID)
void	loadProperties(File propertyFile)	invokes STProperties.setPropertyValue(String, Object) on each of the property/value pairs found in propertyFile
void	setProperties(Properties props)	invokes STProperties.setPropertyValue(String, Object) on each of the property/value pairs found in properties
void	setPropertyValue(String id, Object value)
void	storeProperties(File propertyFile)	stores the properties in this instance in file propertyFile
void	storeProperties(Properties properties)	stores the properties in this instance in the given Properties object properties
String	toString()

Methods inherited from class java.lang.Object

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

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

checkAndConvertPropertyValue, convertToPropertValue, getAnnotations, getHTMLDescription, getHTMLWarning, getPropertyAnnotatedType, getPropertyDisplayName, getPropertyType, getShortName, getStringRepresentation

Constructor Details

STPropertiesImpl

protected STPropertiesImpl()

STPropertiesImpl

protected STPropertiesImpl(File propertyFile)
                    throws IOException,
WrongPropertiesException

Throws:

IOException

WrongPropertiesException

Method Details

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:

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

setProperties

public void setProperties(Properties props)
                   throws WrongPropertiesException

Description copied from interface: STProperties

invokes STProperties.setPropertyValue(String, Object) on each of the property/value pairs found in properties

Specified by:

setProperties in interface STProperties

Throws:

WrongPropertiesException

loadProperties

public void loadProperties(File propertyFile)
                    throws WrongPropertiesException,
IOException

Description copied from interface: STProperties

invokes STProperties.setPropertyValue(String, Object) on each of the property/value pairs found in propertyFile

Specified by:

loadProperties in interface STProperties

Throws:

WrongPropertiesException

IOException

storeProperties

public void storeProperties(File propertyFile)
                     throws IOException,
WrongPropertiesException

Description copied from interface: STProperties

stores the properties in this instance in file propertyFile

Specified by:

storeProperties in interface STProperties

Throws:

IOException

WrongPropertiesException

storeProperties

public void storeProperties(Properties properties)
                     throws IOException,
WrongPropertiesException

Description copied from interface: STProperties

stores the properties in this instance in the given Properties object properties

Specified by:

storeProperties in interface STProperties

Throws:

IOException

WrongPropertiesException

getPropertyContentType

public String getPropertyContentType(String parID)
                              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

isRequiredProperty

public boolean isRequiredProperty(String parID)
                           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:

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

convertToPropertValue

public Object convertToPropertValue(Field prop,
 Object value)

toString

public String toString()

Overrides:

toString in class Object

isEnumerated

public boolean isEnumerated(String id)
                     throws PropertyNotFoundException

Description copied from interface: STProperties

Tells if the property with given id is enumerated: either its type is an enum (see STProperties.getPropertyType(String)) or it is annotated with Enumeration.

Specified by:

isEnumerated 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