org.protempa.backend

Class BackendInstanceSpec<B extends Backend>

java.lang.Object

org.protempa.backend.BackendInstanceSpec<B>

public final class BackendInstanceSpec<B extends Backend>
extends Object

Author:

Andrew Post

Method Summary

Modifier and Type	Method and Description
void	addDisplayNameOverride(String propertyName, String displayName)
void	addRequiredOverride(String propertyName)
BackendSpec<B>	getBackendSpec()
String	getConfigurationsId()
String	getDisplayName(String propertyName)
B	getInstance() Instantiates a new Backend and calls its Backend.initialize(org.protempa.backend.BackendInstanceSpec<?>) method before returning it.
Object	getProperty(String name)
String[]	getPropertyNames()
boolean	isRequired(String propertyName)
void	parseProperty(String name, String valueStr)
void	removeDisplayNameOverride(String propertyName)
void	removeRequiredOverride(String propertyName)
void	setConfigurationsId(String configurationsId)
void	setProperty(BackendPropertySpec spec, Object value)
void	setProperty(String name, Object value)
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getBackendSpec

public BackendSpec<B> getBackendSpec()

setConfigurationsId

public void setConfigurationsId(String configurationsId)

getConfigurationsId

public String getConfigurationsId()

parseProperty

public void parseProperty(String name,
                          String valueStr)
                   throws InvalidPropertyNameException,
                          InvalidPropertyValueException

Throws:

InvalidPropertyNameException

InvalidPropertyValueException

setProperty

public void setProperty(String name,
                        Object value)
                 throws InvalidPropertyNameException,
                        InvalidPropertyValueException

Throws:

InvalidPropertyNameException

InvalidPropertyValueException

setProperty

public void setProperty(BackendPropertySpec spec,
                        Object value)
                 throws InvalidPropertyValueException

Throws:

InvalidPropertyValueException

getProperty

public Object getProperty(String name)
                   throws InvalidPropertyNameException

Throws:

InvalidPropertyNameException

getPropertyNames

public String[] getPropertyNames()

addRequiredOverride

public void addRequiredOverride(String propertyName)
                         throws InvalidPropertyNameException

Throws:

InvalidPropertyNameException

removeRequiredOverride

public void removeRequiredOverride(String propertyName)
                            throws InvalidPropertyNameException

Throws:

InvalidPropertyNameException

isRequired

public boolean isRequired(String propertyName)
                   throws InvalidPropertyNameException

Throws:

InvalidPropertyNameException

addDisplayNameOverride

public void addDisplayNameOverride(String propertyName,
                                   String displayName)
                            throws InvalidPropertyNameException

Throws:

InvalidPropertyNameException

removeDisplayNameOverride

public void removeDisplayNameOverride(String propertyName)
                               throws InvalidPropertyNameException

Throws:

InvalidPropertyNameException

getDisplayName

public String getDisplayName(String propertyName)
                      throws InvalidPropertyNameException

Throws:

InvalidPropertyNameException

getInstance

public B getInstance()
              throws BackendInitializationException,
                     BackendNewInstanceException

Instantiates a new Backend and calls its Backend.initialize(org.protempa.backend.BackendInstanceSpec<?>) method before returning it.

Returns:

Throws:

org.protempa.BackendInitializationException

BackendNewInstanceException

BackendInitializationException

toString

public String toString()

Overrides:

toString in class Object