public abstract class AbstractPluginConfiguration extends Object implements PluginConfiguration
Modifier and Type | Field and Description |
---|---|
protected Map<String,String> |
additionalConfigurationParameters |
Modifier | Constructor and Description |
---|---|
protected |
AbstractPluginConfiguration() |
protected |
AbstractPluginConfiguration(File propertyFile) |
Modifier and Type | Method and Description |
---|---|
Collection<String> |
getConfigurationParameters()
returns all the parameters of the implementing PluginConfiguration subclass, which have been annotated
as
PluginConfigurationParameter |
String |
getParameterContentType(String parID)
get the expected type of content for the parameter.
|
String |
getParameterDescription(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
|
Object |
getParameterValue(String id)
gets the value of a parameter previously set on this configuration
|
boolean |
hasRequiredParameters()
tells if this PluginConfiguration needs to be explicitly set by the user or if it can be used in its
default settings
|
boolean |
isRequiredParameter(String parID) |
void |
loadParameters(File propertyFile)
invokes
PluginConfiguration.setParameter(String, Object) on each of the parameter/value pairs found in
propertyFile |
void |
setParameter(String id,
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(Properties props)
invokes
PluginConfiguration.setParameter(String, Object) on each of the parameter/value pairs found in
properties |
void |
storeParameters(File propertyFile)
stores the parameters of this configuration in file
propertyFile |
void |
storeParameters(Properties props)
stores the parameters of this configuration in a Properties object
|
String |
toString() |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getShortName
protected AbstractPluginConfiguration()
protected AbstractPluginConfiguration(File propertyFile) throws IOException, BadConfigurationException
IOException
BadConfigurationException
public Collection<String> getConfigurationParameters()
PluginConfiguration
PluginConfigurationParameter
getConfigurationParameters
in interface PluginConfiguration
public Object getParameterValue(String id) throws ConfParameterNotFoundException
PluginConfiguration
getParameterValue
in interface PluginConfiguration
ConfParameterNotFoundException
public void setParameter(String id, Object value) throws BadConfigurationException
PluginConfiguration
value
setParameter
in interface PluginConfiguration
BadConfigurationException
public void setParameters(Properties props) throws BadConfigurationException
PluginConfiguration
PluginConfiguration.setParameter(String, Object)
on each of the parameter/value pairs found in
properties
setParameters
in interface PluginConfiguration
BadConfigurationException
public void loadParameters(File propertyFile) throws BadConfigurationException, IOException
PluginConfiguration
PluginConfiguration.setParameter(String, Object)
on each of the parameter/value pairs found in
propertyFile
loadParameters
in interface PluginConfiguration
BadConfigurationException
IOException
public void storeParameters(File propertyFile) throws IOException, BadConfigurationException
PluginConfiguration
propertyFile
storeParameters
in interface PluginConfiguration
IOException
BadConfigurationException
public void storeParameters(Properties props) throws BadConfigurationException
PluginConfiguration
storeParameters
in interface PluginConfiguration
BadConfigurationException
public String getParameterContentType(String parID) throws ConfParameterNotFoundException
PluginConfiguration
getParameterContentType
in interface PluginConfiguration
ConfParameterNotFoundException
public boolean isRequiredParameter(String parID) throws ConfParameterNotFoundException
isRequiredParameter
in interface PluginConfiguration
ConfParameterNotFoundException
public boolean hasRequiredParameters()
PluginConfiguration
hasRequiredParameters
in interface PluginConfiguration
public String getParameterDescription(String id) throws ConfParameterNotFoundException
PluginConfiguration
getParameterDescription
in interface PluginConfiguration
ConfParameterNotFoundException
Copyright © 2016 ART Group, University of Rome, Tor Vergata. All rights reserved.