org.epics.pvmanager.jdbc

Class JDBCServiceMethodDescription

java.lang.Object

org.epics.pvmanager.jdbc.JDBCServiceMethodDescription

public class JDBCServiceMethodDescription
extends Object

The description for a JDBC service method (i.e. a query).

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
JDBCServiceMethodDescription(String name, String description) A new service method with the given name and description.

Method Summary

Methods

Modifier and Type	Method and Description
JDBCServiceMethodDescription	addArgument(String name, String description, Class<?> type) Adds an argument for the query.
JDBCServiceMethodDescription	query(String query) The query mapped to this service method.
JDBCServiceMethodDescription	queryResult(String name, String description) Adds a result for the query.

Methods inherited from class java.lang.Object

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

Constructor Detail

JDBCServiceMethodDescription

public JDBCServiceMethodDescription(String name,
                            String description)

A new service method with the given name and description.

Parameters:

name - the method name

description - the method description

Method Detail

addArgument

public JDBCServiceMethodDescription addArgument(String name,
                                       String description,
                                       Class<?> type)

Adds an argument for the query.

Arguments need to be specified in the same order as they appear in the query.

Parameters:

name - argument name

description - argument description

type - the expected type of the argument

Returns:

this

queryResult

public JDBCServiceMethodDescription queryResult(String name,
                                       String description)

Adds a result for the query.

The result must be specified if the query returns data (i.e. it is a SELECT) and must not be specified if the query does not return data (i.e. INSERT, UPDATE, DELETE, ...).

Parameters:

name - the result name

description - the result description

Returns:

this

query

public JDBCServiceMethodDescription query(String query)

The query mapped to this service method.

Parameters:

query - the query

Returns:

this