edu.emory.cci.aiw.cvrg.eureka.common.comm

Class JobFilter

java.lang.Object

edu.emory.cci.aiw.cvrg.eureka.common.comm.JobFilter

public class JobFilter
extends Object

A communication class used by the service layer to send filter criteria to the ETL layer for job status retrieval tasks.

Author:

hrathod

Constructor Summary

Constructors

Constructor and Description
JobFilter(Long inJobId, Long inUserId, String inState, Date inFrom, Date inTo) Create an instance with the given parameters.
JobFilter(String queryString) Creates a filter by parsing the given string for the needed values.

Method Summary

Modifier and Type	Method and Description
Date	getFrom()
Long	getJobId()
String	getState()
Date	getTo()
Long	getUserId()
String	toQueryParam() Convert the filter object into a string appropriate to be passed as a request parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobFilter

public JobFilter(Long inJobId,
                 Long inUserId,
                 String inState,
                 Date inFrom,
                 Date inTo)

Create an instance with the given parameters. Null parameters are allowed. The inFrom and inTo parameters can be used to create date range to search between.

Parameters:

inJobId - Search for a specific job using a unique identifier.

inUserId - The id of the user who requested the job.

inState - Search for all jobs in a given state.

inFrom - Search for all jobs with a timestamp after the given time.

inTo - Search for all jobs with a timestamp before the given time.

JobFilter

public JobFilter(String queryString)

Creates a filter by parsing the given string for the needed values. The string should be in a pipe-delimited format, with an equal sign separating the key and value. For example, "jobId=1|userId=1|state=STARTED|from=123456|to=123456".

Parameters:

queryString - Parse the filter from this given string.

Method Detail

getJobId

public final Long getJobId()

Returns:

the jobId

getUserId

public final Long getUserId()

Returns:

the userId

getState

public final String getState()

Returns:

the state

getFrom

public final Date getFrom()

Returns:

the from

getTo

public final Date getTo()

Returns:

the to

toQueryParam

public final String toQueryParam()

Convert the filter object into a string appropriate to be passed as a request parameter. This string representation can then be parsed by the String value constructor on the server side.

Returns:

A string representation of the filter.