chemaxon.marvin.services

Class DynamicArgument<CT,RT>

java.lang.Object

chemaxon.marvin.services.ServiceArgument<RT>

chemaxon.marvin.services.DynamicArgument<CT,RT>

Type Parameters:

CT - the context type

RT - the result type

@PublicAPI
public abstract class DynamicArgument<CT,RT>
extends ServiceArgument<RT>

ServiceArguments implementing this interface should support automatic evaluation of arguments before service call based on context.
NOTE: subclasses MUST HAVE default constructor to use from Marvin Sketch

Since:

5.6

Author:

Istvan Rabel

Field Summary

Fields inherited from class chemaxon.marvin.services.ServiceArgument

alias, constant, name, type, value

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DynamicArgument()
protected	DynamicArgument(java.lang.String expression)

Method Summary

Modifier and Type	Method and Description
abstract RT	evaluate(CT context) Evaluates the dynamic argument based on context
java.lang.String	getExpression() Returns the expression used for evaluations
java.lang.String	getPlaceholderText() Returns the value placeholder text.
boolean	isValid() Returns true if service argument is valid
void	setExpression(java.lang.String expression) Sets the expression
java.lang.String	toString()

Methods inherited from class chemaxon.marvin.services.ServiceArgument

createArgument, createArgument, createArgumentAs, createArgumentAs, createConstantFromString, getAlias, getName, getType, getValue, setAlias, setName, setType, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicArgument

protected DynamicArgument()

DynamicArgument

protected DynamicArgument(java.lang.String expression)

Method Detail

setExpression

public void setExpression(java.lang.String expression)

Sets the expression

Parameters:

expression - used for evaluation

getExpression

public java.lang.String getExpression()

Returns the expression used for evaluations

Returns:

the expression used for evaluations

evaluate

public abstract RT evaluate(CT context)

Evaluates the dynamic argument based on context

Parameters:

context - the context of evalution

Returns:

the evaluated value

isValid

public boolean isValid()

Description copied from class: ServiceArgument

Returns true if service argument is valid

Overrides:

isValid in class ServiceArgument<RT>

Returns:

true if service argument is valid

toString

public java.lang.String toString()

Overrides:

toString in class ServiceArgument<RT>

getPlaceholderText

public java.lang.String getPlaceholderText()

Returns the value placeholder text. Defalult implementation returns the String <Calculated>

Returns:

the value placeholder text