NewsFilter (DXFeed News API 437)

java.lang.Object
- com.devexperts.mdd.news.event.NewsFilter

All Implemented Interfaces:: Serializable

public class NewsFilter
extends Object
implements Serializable

Filter for news events.

Sample builder usage:


     NewsFilter filter = NewsFilter.newBuilder()
         .withSources("Business Wire")
         .withOrigins(NewsOrigin.valueOf("mt", "CBS"))
         .withSymbols("AAPL", "MSFT")
         .withLimit(50)
         .withTimeout(60_000L)
         .build();

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NewsFilter.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`NewsFilter.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_DATE_LIMIT` Default date limit - deep past
`static long`	`DEFAULT_INTERVAL_LIMIT` Default interval limit - unlimited
`static int`	`DEFAULT_LIMIT` Default limit for the news count returned in one chunk.
`static long`	`DEFAULT_TIMEOUT` Default time period to wait while polling for news.
`static NewsFilter`	`EMPTY_FILTER` Empty filter with all params set by default.
`static String`	`FILTER_DATE_LIMIT`
`static String`	`FILTER_FEED` Deprecated.
`static String`	`FILTER_INTERVAL_LIMIT`
`static String`	`FILTER_LIMIT`
`static String`	`FILTER_ORIGIN`
`static Set<String>`	`FILTER_PARAMETERS` Set of all available fields for the filter.
`static String`	`FILTER_SOURCE` Deprecated.
`static String`	`FILTER_SYMBOL`
`static String`	`FILTER_TIMEOUT`

Constructor Summary

Constructors
Modifier Constructor and Description

protected NewsFilter(Map<String,Set<String>> params, int originLimits)

Constructors
Modifier	Constructor and Description
`protected`	`NewsFilter(Map<String,Set<String>> params, int originLimits)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`NewsFilter.Builder`	`builder()`
`protected static Set<NewsOrigin>`	`calculateOrigins(Set<String> os, Set<String> fs, Set<String> ss)`
`static NewsFilter`	`emptyFilter()`
`long`	`getDateLimit()` Returns date of the oldest news to return, as UTC time in ms (same as `System.currentTimeMillis()`).
`Set<String>`	`getFeeds()` Deprecated. Use `getOrigins()` instead.
`long`	`getIntervalLimit()` Returns age of the oldest news to return, in milliseconds.
`int`	`getLimit()` Returns maximum number of news to return as requested by client.
`Set<NewsOrigin>`	`getOrigins()` Returns set of all origins to filter on, or `null` otherwise.
`Set<String>`	`getParam(String name)`
`Map<String,Set<String>>`	`getParams()` Returns all filter parameters as a map.
`Set<String>`	`getSources()` Deprecated. Use `getOrigins()` instead.
`Set<String>`	`getSymbols()` Returns set of instrument symbols to filter on, or `null` otherwise.
`long`	`getTimeout()` Sets the timeout in millis to wait while polling for news.
`protected void`	`initialize(int originsLimit)` Initialize and validate all required fields.
`static NewsFilter`	`limitFilter(int limit)`
`static NewsFilter.Builder`	`newBuilder()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - FILTER_FEED
```
@Deprecated
public static final String FILTER_FEED
```
    Deprecated.
    
    See Also:
    
    getFeeds(), Constant Field Values
  - FILTER_SOURCE
```
@Deprecated
public static final String FILTER_SOURCE
```
    Deprecated.
    
    See Also:
    
    getSources(), Constant Field Values
  - FILTER_ORIGIN
```
public static final String FILTER_ORIGIN
```
    See Also:
    
    NewsFilter@getOrigins(), Constant Field Values
  - FILTER_SYMBOL
```
public static final String FILTER_SYMBOL
```
    See Also:
    
    getSymbols(), Constant Field Values
  - FILTER_LIMIT
```
public static final String FILTER_LIMIT
```
    See Also:
    
    getLimit(), Constant Field Values
  - FILTER_DATE_LIMIT
```
public static final String FILTER_DATE_LIMIT
```
    See Also:
    
    getDateLimit(), Constant Field Values
  - FILTER_INTERVAL_LIMIT
```
public static final String FILTER_INTERVAL_LIMIT
```
    See Also:
    
    getIntervalLimit(), Constant Field Values
  - FILTER_TIMEOUT
```
public static final String FILTER_TIMEOUT
```
    See Also:
    
    getTimeout(), Constant Field Values
  - FILTER_PARAMETERS
```
public static final Set<String> FILTER_PARAMETERS
```
    Set of all available fields for the filter.
  - EMPTY_FILTER
```
public static final NewsFilter EMPTY_FILTER
```
    Empty filter with all params set by default.
  - DEFAULT_LIMIT
```
public static final int DEFAULT_LIMIT
```
    Default limit for the news count returned in one chunk.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_TIMEOUT
```
public static final long DEFAULT_TIMEOUT
```
    Default time period to wait while polling for news.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DATE_LIMIT
```
public static final long DEFAULT_DATE_LIMIT
```
    Default date limit - deep past
    
    See Also:
    
    Constant Field Values
  - DEFAULT_INTERVAL_LIMIT
```
public static final long DEFAULT_INTERVAL_LIMIT
```
    Default interval limit - unlimited
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - NewsFilter
```
protected NewsFilter(Map<String,Set<String>> params,
                     int originLimits)
```
- Method Detail
  - newBuilder
```
public static NewsFilter.Builder newBuilder()
```
  - limitFilter
```
public static NewsFilter limitFilter(int limit)
```
  - emptyFilter
```
public static NewsFilter emptyFilter()
```
  - builder
```
public NewsFilter.Builder builder()
```
  - getFeeds
```
@Deprecated
public Set<String> getFeeds()
```
    Deprecated. Use getOrigins() instead.
    
    Returns set of feeds to filter on, or null otherwise.
    These feeds will be converted to origins in form of <feed>:*.
  - getSources
```
@Deprecated
public Set<String> getSources()
```
    Deprecated. Use getOrigins() instead.
    
    Returns set of sources to filter on, or null otherwise.
    These sources will be converted to origins in form of *:<source>:*.
  - getOrigins
```
public Set<NewsOrigin> getOrigins()
```
    Returns set of all origins to filter on, or null otherwise.
    Origins will include all added origins and all feeds and sources converted into origins.
  - getSymbols
```
public Set<String> getSymbols()
```
    Returns set of instrument symbols to filter on, or null otherwise.
  - getLimit
```
public int getLimit()
```
    Returns maximum number of news to return as requested by client. Note that server can return smaller number than requested due to entitlements.
  - getDateLimit
```
public long getDateLimit()
```
    Returns date of the oldest news to return, as UTC time in ms (same as System.currentTimeMillis()). Note that server can restrict history due to entitlements.
  - getIntervalLimit
```
public long getIntervalLimit()
```
    Returns age of the oldest news to return, in milliseconds. Note that server can restrict history due to entitlements.
  - getTimeout
```
public long getTimeout()
```
    Sets the timeout in millis to wait while polling for news. Note that server can use smaller timeout than requested due to entitlements.
  - getParams
```
public Map<String,Set<String>> getParams()
```
    Returns all filter parameters as a map.
  - getParam
```
public Set<String> getParam(String name)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - initialize
```
protected void initialize(int originsLimit)
```
    Initialize and validate all required fields.
  - calculateOrigins
```
protected static Set<NewsOrigin> calculateOrigins(Set<String> os,
                                                  Set<String> fs,
                                                  Set<String> ss)
```

Class NewsFilter

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FILTER_FEED

FILTER_SOURCE

FILTER_ORIGIN

FILTER_SYMBOL

FILTER_LIMIT

FILTER_DATE_LIMIT

FILTER_INTERVAL_LIMIT

FILTER_TIMEOUT

FILTER_PARAMETERS

EMPTY_FILTER

DEFAULT_LIMIT

DEFAULT_TIMEOUT

DEFAULT_DATE_LIMIT

DEFAULT_INTERVAL_LIMIT

Constructor Detail

NewsFilter

Method Detail

newBuilder

limitFilter

emptyFilter

builder

getFeeds

getSources

getOrigins

getSymbols

getLimit

getDateLimit

getIntervalLimit

getTimeout

getParams

getParam

toString

initialize

calculateOrigins