com.dxfeed.schedule

Class SessionFilter

java.lang.Object

com.dxfeed.schedule.SessionFilter

All Implemented Interfaces:

Serializable

public class SessionFilter
extends Object
implements Serializable

A filter for sessions used by various search methods. This class provides predefined filters for certain Session attributes, although users can create their own filters to suit their needs.

Please note that sessions can be either trading or non-trading, and this distinction can be either based on rules (e.g. weekends) or dictated by special occasions (e.g. holidays). Different filters treat this distinction differently - some accept only trading sessions, some only non-trading, and some ignore type of session altogether.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static SessionFilter	AFTER_MARKET Accepts any session with type SessionType.AFTER_MARKET.
static SessionFilter	ANY Accepts any session - useful for pure schedule navigation.
static SessionFilter	NO_TRADING Accepts any session with type SessionType.NO_TRADING.
static SessionFilter	NON_TRADING Accepts non-trading sessions only - those with (Session.isTrading() == false).
static SessionFilter	PRE_MARKET Accepts any session with type SessionType.PRE_MARKET.
static SessionFilter	REGULAR Accepts any session with type SessionType.REGULAR.
protected Boolean	trading Required trading flag, null if not relevant.
static SessionFilter	TRADING Accepts trading sessions only - those with (Session.isTrading() == true).
protected SessionType	type Required type, null if not relevant.

Constructor Summary

Constructors

Constructor and Description
SessionFilter(SessionType type, Boolean trading) Creates filter with specified type and trading flag conditions.

Method Summary

Modifier and Type	Method and Description
boolean	accept(Session session) Tests whether or not the specified session is an acceptable result.
boolean	equals(Object object)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ANY

public static final SessionFilter ANY

Accepts any session - useful for pure schedule navigation.

TRADING

public static final SessionFilter TRADING

Accepts trading sessions only - those with (Session.isTrading() == true).

NON_TRADING

public static final SessionFilter NON_TRADING

Accepts non-trading sessions only - those with (Session.isTrading() == false).

NO_TRADING

public static final SessionFilter NO_TRADING

Accepts any session with type SessionType.NO_TRADING.

PRE_MARKET

public static final SessionFilter PRE_MARKET

Accepts any session with type SessionType.PRE_MARKET.

REGULAR

public static final SessionFilter REGULAR

Accepts any session with type SessionType.REGULAR.

AFTER_MARKET

public static final SessionFilter AFTER_MARKET

Accepts any session with type SessionType.AFTER_MARKET.

type

protected final SessionType type

Required type, null if not relevant.

trading

protected final Boolean trading

Required trading flag, null if not relevant.

Constructor Detail

SessionFilter

public SessionFilter(SessionType type,
                     Boolean trading)

Creates filter with specified type and trading flag conditions.

Both parameters specify what value corresponding attributes should have. If some parameter is null then corresponding attribute is ignored (any value is accepted).

Parameters:

type - required type, null if not relevant

trading - required trading flag, null if not relevant

Method Detail

accept

public boolean accept(Session session)

Tests whether or not the specified session is an acceptable result.

Parameters:

session - the session to be tested

Returns:

true if specified session is accepted

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object