org.apache.streams.sysomos.provider

Class ContentRequestBuilder

java.lang.Object

org.apache.streams.sysomos.provider.AbstractRequestBuilder

org.apache.streams.sysomos.provider.ContentRequestBuilder

All Implemented Interfaces:

RequestBuilder

public class ContentRequestBuilder
extends AbstractRequestBuilder
implements RequestBuilder

Builds requests for the Sysomos Heartbeat Content API. This is the preferred method of accessing data from Sysomoos Heartbeat

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_ALLOWED_PER_REQUEST The max number of items you are allowed to get per request.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ContentRequestBuilder(String baseUrl, String apiKey) Constructs a new ContentRequestBuilder for the specified API key and Sysomos URL.

Method Summary

Modifier and Type	Method and Description
URL	getRequestUrl() Gets the Request URL based on the local fields.
RequestBuilder	setAddedAfterDate(org.joda.time.DateTime afterDate) Sets the date after which documents should be returned from Sysomos.
RequestBuilder	setAddedBeforeDate(org.joda.time.DateTime beforeDate) Sets the date before which documents should be returned from Sysomos.
RequestBuilder	setHeartBeatId(int hid) Sets the Sysomos Heartbeat ID.
RequestBuilder	setHeartBeatId(String hid) Sets the Sysomos Heartbeat ID as a String.
RequestBuilder	setOffset(long offset) Sets the starting offset for the number of documents given the other parameters.
RequestBuilder	setReturnSetSize(long size) Sets the size of the expected response.

Methods inherited from class org.apache.streams.sysomos.provider.AbstractRequestBuilder

execute

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.streams.sysomos.provider.RequestBuilder

execute

Field Detail

MAX_ALLOWED_PER_REQUEST

public static final int MAX_ALLOWED_PER_REQUEST

The max number of items you are allowed to get per request.

See Also:

Constant Field Values

Constructor Detail

ContentRequestBuilder

protected ContentRequestBuilder(String baseUrl,
                                String apiKey)

Constructs a new ContentRequestBuilder for the specified API key and Sysomos URL.

Parameters:

baseUrl - the base URL for the sysomos API

apiKey - the API key generated by Sysomos for authorization

Method Detail

getRequestUrl

public URL getRequestUrl()

Gets the Request URL based on the local fields.

Specified by:

getRequestUrl in interface RequestBuilder

Returns:

a valid URL for the Sysomos API or an exception

setHeartBeatId

public RequestBuilder setHeartBeatId(int hid)

Description copied from interface: RequestBuilder

Sets the Sysomos Heartbeat ID.

Specified by:

setHeartBeatId in interface RequestBuilder

Parameters:

hid - Heartbeat ID

Returns:

The RequestBuilder for continued Chaining

setHeartBeatId

public RequestBuilder setHeartBeatId(String hid)

Description copied from interface: RequestBuilder

Sets the Sysomos Heartbeat ID as a String.

Specified by:

setHeartBeatId in interface RequestBuilder

Parameters:

hid - Heartbeat ID string

Returns:

The RequestBuilder for continued Chaining

setAddedAfterDate

public RequestBuilder setAddedAfterDate(org.joda.time.DateTime afterDate)

Description copied from interface: RequestBuilder

Sets the date after which documents should be returned from Sysomos.

Specified by:

setAddedAfterDate in interface RequestBuilder

Parameters:

afterDate - the DateTime instance representing the after date

Returns:

The RequestBuilder for continued Chaining

setAddedBeforeDate

public RequestBuilder setAddedBeforeDate(org.joda.time.DateTime beforeDate)

Description copied from interface: RequestBuilder

Sets the date before which documents should be returned from Sysomos.

Specified by:

setAddedBeforeDate in interface RequestBuilder

Parameters:

beforeDate - the DateTime instance representing the before date

Returns:

The RequestBuilder for continued Chaining

setReturnSetSize

public RequestBuilder setReturnSetSize(long size)

Description copied from interface: RequestBuilder

Sets the size of the expected response.

Specified by:

setReturnSetSize in interface RequestBuilder

Parameters:

size - the number of documents

Returns:

The RequestBuilder for continued Chaining

setOffset

public RequestBuilder setOffset(long offset)

Description copied from interface: RequestBuilder

Sets the starting offset for the number of documents given the other parameters.

Specified by:

setOffset in interface RequestBuilder

Parameters:

offset - the starting offset

Returns:

The RequestBuilder for continued Chaining