com.dxfeed.ipf

Class InstrumentProfileReader

java.lang.Object

com.dxfeed.ipf.InstrumentProfileReader

public class InstrumentProfileReader
extends Object

Reads instrument profiles from the stream using Simple File Format. Please see Instrument Profile Format documentation for complete description. This reader automatically uses data formats as specified in the stream.

Use InstrumentProfileConnection if support for streaming updates of instrument profiles is needed.

Constructor Summary

Constructors

Constructor and Description
InstrumentProfileReader() Creates instrument profile reader.

Method Summary

Modifier and Type	Method and Description
long	getLastModified() Returns last modification time (in milliseconds) from last readFromFile(java.lang.String) operation or zero if it is unknown.
protected String	intern(String value) To be overridden in subclasses to allow intern strings using pools (like StringCache) to reduce memory footprint.
List<InstrumentProfile>	read(InputStream in) Reads and returns instrument profiles from specified plain data stream.
List<InstrumentProfile>	read(InputStream in, String name) Deprecated. use readCompressed(InputStream), it detects compressed streams automatically.
List<InstrumentProfile>	readCompressed(InputStream in) Reads and returns instrument profiles from specified stream.
List<InstrumentProfile>	readFromFile(String address) Reads and returns instrument profiles from specified file.
List<InstrumentProfile>	readFromFile(String address, String user, String password) Reads and returns instrument profiles from specified address with a specified basic user and password credentials.
static String	resolveSourceURL(String address) Converts a specified string address specification into an URL that will be read by readFromFile(java.lang.String) method using URLInputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

InstrumentProfileReader

public InstrumentProfileReader()

Creates instrument profile reader.

Method Detail

getLastModified

public long getLastModified()

Returns last modification time (in milliseconds) from last readFromFile(java.lang.String) operation or zero if it is unknown.

readFromFile

public List<InstrumentProfile> readFromFile(String address)
                                     throws IOException

Reads and returns instrument profiles from specified file. This method recognizes data compression formats "zip" and "gzip" automatically. In case of zip the first file entry will be read and parsed as a plain data stream. In case of gzip compressed content will be read and processed. In other cases data considered uncompressed and will be parsed as is.

Authentication information can be supplied to this method as part of URL user info like "http://user:password@host:port/path/file.ipf".

This is a shortcut for readFromFile(address, null, null).

This operation updates lastModified.

Parameters:

address - URL of file to read from

Returns:

list of instrument profiles

Throws:

InstrumentProfileFormatException - if input stream does not conform to the Simple File Format

IOException - If an I/O error occurs

readFromFile

public List<InstrumentProfile> readFromFile(String address,
                                            String user,
                                            String password)
                                     throws IOException

Reads and returns instrument profiles from specified address with a specified basic user and password credentials. This method recognizes data compression formats "zip" and "gzip" automatically. In case of zip the first file entry will be read and parsed as a plain data stream. In case of gzip compressed content will be read and processed. In other cases data considered uncompressed and will be parsed as is.

Specified user and password take precedence over authentication information that is supplied to this method as part of URL user info like "http://user:password@host:port/path/file.ipf".

This operation updates lastModified.

Parameters:

address - URL of file to read from.

user - the user name (may be null).

password - the password (may be null).

Returns:

list of instrument profiles.

Throws:

InstrumentProfileFormatException - if input stream does not conform to the Simple File Format.

IOException - If an I/O error occurs.

resolveSourceURL

public static String resolveSourceURL(String address)

Converts a specified string address specification into an URL that will be read by readFromFile(java.lang.String) method using URLInputStream.

read

public final List<InstrumentProfile> read(InputStream in,
                                          String name)
                                   throws IOException

Deprecated. use readCompressed(InputStream), it detects compressed streams automatically.

Reads and returns instrument profiles from specified stream using specified name to select data compression format.

DEPRECATION NOTE: current implementation ignores provided name and falls back to automatic detection of compressed streams using readCompressed(InputStream). Also multi-file zip archives or zip archives containing compressed file are not supported since v3.297.

Throws:

InstrumentProfileFormatException - if input stream does not conform to the Simple File Format

IOException - If an I/O error occurs

See Also:

readCompressed(InputStream)

readCompressed

public final List<InstrumentProfile> readCompressed(InputStream in)
                                             throws IOException

Reads and returns instrument profiles from specified stream. This method recognizes data compression formats "zip" and "gzip" automatically. In case of zip the first file entry will be read and parsed as a plain data stream. In case of gzip compressed content will be read and processed. In other cases data considered uncompressed and will be parsed as is.

Throws:

InstrumentProfileFormatException - if input stream does not conform to the Simple File Format

IOException - If an I/O error occurs

read

public List<InstrumentProfile> read(InputStream in)
                             throws IOException

Reads and returns instrument profiles from specified plain data stream. For potentially compressed data use readCompressed(java.io.InputStream) method.

Throws:

InstrumentProfileFormatException - if input stream does not conform to the Simple File Format

IOException - If an I/O error occurs

intern

protected String intern(String value)

To be overridden in subclasses to allow intern strings using pools (like StringCache) to reduce memory footprint. Default implementation does nothing (returns value itself).

Parameters:

value - string value to intern

Returns:

canonical representation of the given string value