nl.esi.metis.aisparser.provenance.Provenance Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of EsiAisParser Show documentation

This package supports the parsing of AIS messages in Java. AIS, the Automatic Identification System, is a system aiming at improving maritime safety by exchanging messages between ships, other vehicles in particular aircraft involved in search-and-rescue (SAR), and (fixed) base stations. To be precise, this package support the ITU-R M.1371-4 AIS standard. See our extensive javadoc and in particular the class AISParser for more information on how to use this package. The parser was used in the Poseidon project, and is improved in the Metis project to better handle uncertain information. Both projects were led by the Embedded Systems Institute. In both projects Thales Nederlands was the carrying industrial partner, and multiple Dutch universities participated.

The newest version!

package nl.esi.metis.aisparser.provenance;

import java.util.List;

import nl.esi.metis.aisparser.annotations.Annotation;

/** This interface provides access to information on where a particular information item (e.g., an AIS message) originally came from.
 * @author Pierre America
 * @author Pierre van de Laar
 */
public interface Provenance {
	/** Returns the time stamp when the information item was created.
	 * @return the time stamp (in seconds from January 1, 1970)
	 */
	public double getTime();
	
	/** Returns a description of the provenance of the information item.
	 * @param layout a string that should be added to the beginning of every line
	 * @return a string describing the provenance, possibly consisting of multiple lines
	 */
	public String getProvenanceTree(String layout);
	
	/** Returns all quality of information annotations associated with the information item in its provenance tree.
	 * When getAnnotations().length == 0, the quality of information associated with the information item is perfect.
	 * @return a list of annotations
	 */
	public List getAnnotations();
}