it.uniroma2.art.owlart.models.conf

Class ModelConfigurationImpl

java.lang.Object

it.uniroma2.art.owlart.models.conf.ModelConfigurationImpl

All Implemented Interfaces:

ModelConfiguration

Direct Known Subclasses:

RemoteModelConfigurationImpl

public abstract class ModelConfigurationImpl
extends java.lang.Object
implements ModelConfiguration

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ModelConfigurationImpl()
protected	ModelConfigurationImpl(java.io.File propertyFile)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	getConfigurationParameters() returns all the parameters of the implementing ModelConfiguration subclass, which have been annotated as ModelConfigurationParameter
java.lang.String	getParameterContentType(java.lang.String parID) get the expected type of content for the parameter.
java.lang.String	getParameterDescription(java.lang.String id) this method is useful when OWL ART API are embedded inside tools presenting list of configuration parameters for being set by the users, to provide hints for the user on which kind of values should be used to fill them
java.lang.Object	getParameterValue(java.lang.String id) gets the value of a parameter previously set on this configuration
boolean	hasRequiredParameters() tells if this ModelConfiguration needs to be explicitly set by the user or if it can be used in its default settings
boolean	isRequiredParameter(java.lang.String parID)
void	loadParameters(java.io.File propertyFile) invokes ModelConfiguration.setParameter(String, Object) on each of the parameter/value pairs found in propertyFile
void	setParameter(java.lang.String id, java.lang.Object value) sets the value of the Configuration Parameter to value Note that it is possible to pass the value both with the proper type, if it is known in advance, as well with a generic String, which will be evaluated and converted to the appropriate type.
void	setParameters(java.util.Properties props) invokes ModelConfiguration.setParameter(String, Object) on each of the parameter/value pairs found in properties
void	storeParameters(java.io.File propertyFile) stores the parameters of this configuration in file propertyFile
java.lang.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.owlart.models.conf.ModelConfiguration

getShortName

Constructor Detail

ModelConfigurationImpl

protected ModelConfigurationImpl()

ModelConfigurationImpl

protected ModelConfigurationImpl(java.io.File propertyFile)
                          throws java.io.IOException,
                                 BadConfigurationException

Throws:

java.io.IOException

BadConfigurationException

Method Detail

getConfigurationParameters

public java.util.Collection<java.lang.String> getConfigurationParameters()

Description copied from interface: ModelConfiguration

returns all the parameters of the implementing ModelConfiguration subclass, which have been annotated as ModelConfigurationParameter

Specified by:

getConfigurationParameters in interface ModelConfiguration

Returns:

getParameterValue

public java.lang.Object getParameterValue(java.lang.String id)
                                   throws ConfParameterNotFoundException

Description copied from interface: ModelConfiguration

gets the value of a parameter previously set on this configuration

Specified by:

getParameterValue in interface ModelConfiguration

Returns:

Throws:

ConfParameterNotFoundException

setParameter

public void setParameter(java.lang.String id,
                java.lang.Object value)
                  throws BadConfigurationException

Description copied from interface: ModelConfiguration

sets the value of the Configuration Parameter to value
Note that it is possible to pass the value both with the proper type, if it is known in advance, as well with a generic String, which will be evaluated and converted to the appropriate type. Supported types are now:

• Boolean
• Integer
• Long
• Double

Specified by:

setParameter in interface ModelConfiguration

Throws:

BadConfigurationException

setParameters

public void setParameters(java.util.Properties props)
                   throws BadConfigurationException

Description copied from interface: ModelConfiguration

invokes ModelConfiguration.setParameter(String, Object) on each of the parameter/value pairs found in properties

Specified by:

setParameters in interface ModelConfiguration

Throws:

BadConfigurationException

loadParameters

public void loadParameters(java.io.File propertyFile)
                    throws BadConfigurationException,
                           java.io.IOException

Description copied from interface: ModelConfiguration

invokes ModelConfiguration.setParameter(String, Object) on each of the parameter/value pairs found in propertyFile

Specified by:

loadParameters in interface ModelConfiguration

Throws:

BadConfigurationException

java.io.IOException

storeParameters

public void storeParameters(java.io.File propertyFile)
                     throws java.io.IOException,
                            BadConfigurationException

Description copied from interface: ModelConfiguration

stores the parameters of this configuration in file propertyFile

Specified by:

storeParameters in interface ModelConfiguration

Throws:

java.io.IOException

BadConfigurationException

getParameterContentType

public java.lang.String getParameterContentType(java.lang.String parID)
                                         throws ConfParameterNotFoundException

Description copied from interface: ModelConfiguration

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

Specified by:

getParameterContentType in interface ModelConfiguration

Returns:

Throws:

ConfParameterNotFoundException

isRequiredParameter

public boolean isRequiredParameter(java.lang.String parID)
                            throws ConfParameterNotFoundException

Specified by:

isRequiredParameter in interface ModelConfiguration

Throws:

ConfParameterNotFoundException

hasRequiredParameters

public boolean hasRequiredParameters()

Description copied from interface: ModelConfiguration

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

Specified by:

hasRequiredParameters in interface ModelConfiguration

Returns:

getParameterDescription

public java.lang.String getParameterDescription(java.lang.String id)
                                         throws ConfParameterNotFoundException

Description copied from interface: ModelConfiguration

this method is useful when OWL ART API are embedded inside tools presenting list of configuration parameters for being set by the users, to provide hints for the user on which kind of values should be used to fill them

Specified by:

getParameterDescription in interface ModelConfiguration

Returns:

Throws:

ConfParameterNotFoundException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object