Package it.uniroma2.art.semanticturkey.plugin.configuration

Class AbstractPluginConfiguration

java.lang.Object

it.uniroma2.art.semanticturkey.properties.STPropertiesImpl

it.uniroma2.art.semanticturkey.plugin.configuration.AbstractPluginConfiguration

All Implemented Interfaces:

STProperties

public abstract class AbstractPluginConfiguration
extends STPropertiesImpl
implements STProperties

Abstract base class of plugin configuration objects supporting additional properties (in addition to the ones defined as annotated fields).

Author:

Manuel Fiorelli

Nested Class Summary

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

STProperties.BasicPropertiesConstraints, STProperties.BasicPropertyConstraintValidator

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,String>	additionalConfigurationParameters

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractPluginConfiguration()

Method Summary

Modifier and Type	Method	Description
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 parID)	get the expected type of content for the property.
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
boolean	isRequiredProperty(String parID)
void	setPropertyValue(String id, Object value)

Methods inherited from class it.uniroma2.art.semanticturkey.properties.STPropertiesImpl

convertToPropertValue, getEnumeration, hasRequiredProperties, isEnumerated, loadProperties, setProperties, storeProperties, storeProperties, 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, getEnumeration, getHTMLDescription, getHTMLWarning, getPropertyType, getShortName, getStringRepresentation, hasRequiredProperties, isEnumerated, loadProperties, setProperties, storeProperties, storeProperties

Field Details

additionalConfigurationParameters

protected Map<String,String> additionalConfigurationParameters

Constructor Details

AbstractPluginConfiguration

protected AbstractPluginConfiguration()

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

Overrides:

getProperties in class STPropertiesImpl

Returns:

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

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

Overrides:

getPropertyValue in class STPropertiesImpl

Returns:

Throws:

PropertyNotFoundException

setPropertyValue

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

Specified by:

setPropertyValue in interface STProperties

Overrides:

setPropertyValue in class STPropertiesImpl

Throws:

WrongPropertiesException

getPropertyAnnotatedType

public AnnotatedType getPropertyAnnotatedType(String id)
                                       throws PropertyNotFoundException

Specified by:

getPropertyAnnotatedType in interface STProperties

Throws:

PropertyNotFoundException

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

Overrides:

getPropertyContentType in class STPropertiesImpl

Returns:

Throws:

PropertyNotFoundException

isRequiredProperty

public boolean isRequiredProperty(String parID)
                           throws PropertyNotFoundException

Specified by:

isRequiredProperty in interface STProperties

Overrides:

isRequiredProperty in class STPropertiesImpl

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

Overrides:

getPropertyDescription in class STPropertiesImpl

Returns:

Throws:

PropertyNotFoundException