pt.lsts.neptus.mra.importers.jsf

Class JsfLog

java.lang.Object

pt.lsts.neptus.mra.importers.jsf.JsfLog

All Implemented Interfaces:

IMraLog

public class JsfLog
extends java.lang.Object
implements IMraLog

Author:

jqcorreia

Constructor Summary

Constructors

Constructor and Description
JsfLog(java.lang.String fileName)

Method Summary

Modifier and Type	Method and Description
void	advance(long millis) Advance millis milliseconds in the log
long	currentTimeMillis() The timestamp of the current log entry (first entry by default)
pt.lsts.imc.IMCMessage	firstLogEntry() Goes back to the first Log Entry and retrieves it
pt.lsts.imc.IMCMessageType	format() Retrieve the log format as a Neptus message type
pt.lsts.imc.IMCMessage	getCurrentEntry() Retrieve all messages that have the given timestamp
pt.lsts.imc.IMCMessage	getEntryAtOrAfter(long timestamp)
pt.lsts.imc.IMCMessage	getEntryAtOrAfter(long timestamp, java.lang.String entityName)
java.util.Collection<pt.lsts.imc.IMCMessage>	getExactTimeEntries(long timeStampMillis) Retrieve all messages that have the given timestamp
pt.lsts.imc.IMCMessage	getLastEntry() Retrieve the last entry in this log
int	getNumberOfEntries() Retrieve the total number of entries in this log
java.util.LinkedHashMap<java.lang.String,java.lang.Object>	metaInfo() Retrieve meta-information associated with this log
java.lang.String	name() Retrieve a name that will identify this log file (like the name of the message)
pt.lsts.imc.IMCMessage	nextLogEntry() Advance to the next Log entry and retrieve it as a IMCMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

JsfLog

public JsfLog(java.lang.String fileName)

Method Detail

getEntryAtOrAfter

public pt.lsts.imc.IMCMessage getEntryAtOrAfter(long timestamp)

Specified by:

getEntryAtOrAfter in interface IMraLog

getEntryAtOrAfter

public pt.lsts.imc.IMCMessage getEntryAtOrAfter(long timestamp,
                                                java.lang.String entityName)

Specified by:

getEntryAtOrAfter in interface IMraLog

name

public java.lang.String name()

Description copied from interface: IMraLog

Retrieve a name that will identify this log file (like the name of the message)

Specified by:

name in interface IMraLog

Returns:

A string with the log name

getLastEntry

public pt.lsts.imc.IMCMessage getLastEntry()

Description copied from interface: IMraLog

Retrieve the last entry in this log

Specified by:

getLastEntry in interface IMraLog

format

public pt.lsts.imc.IMCMessageType format()

Description copied from interface: IMraLog

Retrieve the log format as a Neptus message type

Specified by:

format in interface IMraLog

Returns:

a MessageType indicating the various log fields. The message type may or may not be attached to an existing IMC message. The latter happens for new messages and also for different IMC versions.

metaInfo

public java.util.LinkedHashMap<java.lang.String,java.lang.Object> metaInfo()

Description copied from interface: IMraLog

Retrieve meta-information associated with this log

Specified by:

metaInfo in interface IMraLog

Returns:

Log Meta-information

currentTimeMillis

public long currentTimeMillis()

Description copied from interface: IMraLog

The timestamp of the current log entry (first entry by default)

Specified by:

currentTimeMillis in interface IMraLog

Returns:

The time of the active log entry

nextLogEntry

public pt.lsts.imc.IMCMessage nextLogEntry()

Description copied from interface: IMraLog

Advance to the next Log entry and retrieve it as a IMCMessage

Specified by:

nextLogEntry in interface IMraLog

Returns:

The next log entry as a IMCMessage or null if no more message exist

firstLogEntry

public pt.lsts.imc.IMCMessage firstLogEntry()

Description copied from interface: IMraLog

Goes back to the first Log Entry and retrieves it

Specified by:

firstLogEntry in interface IMraLog

Returns:

Retrieves the first log entry it an entry exists in this log file or otherwise returns null

advance

public void advance(long millis)

Description copied from interface: IMraLog

Advance millis milliseconds in the log

Specified by:

advance in interface IMraLog

Parameters:

millis - The time to advance, in milliseconds

getCurrentEntry

public pt.lsts.imc.IMCMessage getCurrentEntry()

Description copied from interface: IMraLog

Retrieve all messages that have the given timestamp

Specified by:

getCurrentEntry in interface IMraLog

Returns:

A collection of IMCMessages that have the given time stamp

getExactTimeEntries

public java.util.Collection<pt.lsts.imc.IMCMessage> getExactTimeEntries(long timeStampMillis)

Description copied from interface: IMraLog

Retrieve all messages that have the given timestamp

Specified by:

getExactTimeEntries in interface IMraLog

Parameters:

timeStampMillis - Time stamp, in milliseconds

Returns:

A collection of IMCMessages that have the given time stamp

getNumberOfEntries

public int getNumberOfEntries()

Description copied from interface: IMraLog

Retrieve the total number of entries in this log

Specified by:

getNumberOfEntries in interface IMraLog

Returns:

the total number of entries in this log