com.univocity.api.entity.custom
Interface CustomQuery

All Superinterfaces:
CustomReadableEntity

public interface CustomQuery
extends CustomReadableEntity

Provides support for custom implementations of CustomReadableEntity with parameterization support.

The query definition is given by a String. New instances of custom queries should be created by the parent data store (using CustomDataStore.addQuery(String, String)).

Instances of this interface are expected to be obtained via a CustomDataStore through CustomDataStore.getQueries()
Implementations of CustomQuery provide a query-like behavior:

Note uniVocity does not allow writing operations on such entities.

Author:
uniVocity Software Pty Ltd - dev@univocity.com
See Also:
QuerySetup, CustomDataStore, CustomReadableEntity, ReadingProcess

Method Summary
 String[] getParameters()
          Informs what parameters are available through this entity, and in what order.
 void setParameter(String parameterName, Object parameterValue)
          Associates a value, provided by uniVocity, to a parameter.
 
Methods inherited from interface com.univocity.api.entity.custom.CustomReadableEntity
getEntityName, getFields, preareToRead
 

Method Detail

getParameters

String[] getParameters()
Informs what parameters are available through this entity, and in what order.
The returned parameter names array cannot contain duplicates. Parameter names are case insensitive, therefore "param1" and "Param1" are considered the same name.

Returns:
the sequence of parameters supported by this entity.

setParameter

void setParameter(String parameterName,
                  Object parameterValue)
Associates a value, provided by uniVocity, to a parameter.

Parameters:
parameterName - the name of the parameter to be set
parameterValue - the value associated with the given parameter.


Copyright © 2015 uniVocity Software Pty Ltd. All rights reserved.