org.adroitlogic.x.feature.db.models

Class DBConfigPathParameter

java.lang.Object

org.adroitlogic.x.feature.db.models.AbstractDBConfigParameter

org.adroitlogic.x.feature.db.models.DBConfigPathParameter

public class DBConfigPathParameter
extends AbstractDBConfigParameter

Model class for payload value parameters.

Since:

17.01

Author:

Dulaj Atapattu

Constructor Summary

Constructors

Constructor and Description
DBConfigPathParameter()

Method Summary

Modifier and Type	Method and Description
String	getPath()
Object	getValue(org.adroitlogic.x.api.XMessageContext xMessageContext, Object... args) Returns the actual value to insert to the database.
boolean	isParsingRequired() Whether the payload should be parsed to extract parameter values.
void	setPath(String path)
String	toString()
void	validate() Checks whether the values of the parameter attributes are valid or not.

Methods inherited from class org.adroitlogic.x.feature.db.models.AbstractDBConfigParameter

getName, setName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DBConfigPathParameter

public DBConfigPathParameter()

Method Detail

getPath

public String getPath()

setPath

public void setPath(String path)

isParsingRequired

public boolean isParsingRequired()

Description copied from class: AbstractDBConfigParameter

Whether the payload should be parsed to extract parameter values.

Specified by:

isParsingRequired in class AbstractDBConfigParameter

Returns:

true - If parsing is required. Else false.

validate

public void validate()

Description copied from class: AbstractDBConfigParameter

Checks whether the values of the parameter attributes are valid or not. This method should be overridden and required implementation should be provided in child classes.

Overrides:

validate in class AbstractDBConfigParameter

getValue

public Object getValue(org.adroitlogic.x.api.XMessageContext xMessageContext,
                       Object... args)

Returns the actual value to insert to the database. The value is extracted from the message payload.

Specified by:

getValue in class AbstractDBConfigParameter

Parameters:

xMessageContext - XMessageContext instance of the message.

args - First optional argument is the MessageType of the payload.

Returns:

The value extracted from the message.

toString

public String toString()

Overrides:

toString in class AbstractDBConfigParameter