peakml.io
Class FileInfo

java.lang.Object
  peakml.Annotatable
      peakml.io.FileInfo

public class FileInfo
extends Annotatable

Central point for collecting all the information about a file. Files in peakml are either the raw input files or the intermediate files, which have been processed. The vocabulary and the annotations can be used to store the data about the processing done on the file.

Constructor Summary

FileInfo(java.lang.String label, java.lang.String filename)
Convenience constructor, which looks up the location of the given filename in the file-system.

FileInfo(java.lang.String label, java.lang.String name, java.lang.String location)
Constructs a new file info instance with the given values.

Method Summary

java.lang.String	getLabel() Returns the optional label for the file.
java.lang.String	getLocation() Returns the complete path to the file.
java.lang.String	getName() Returns the filename excluding the complete path, which can be retrieved with getLocation().
void	setLabel(java.lang.String label) Sets the optional label for the file.
void	setLocation(java.lang.String location) Sets the complete path to the file.
void	setName(java.lang.String name) Sets the filename excluding the complete path of the file.

Methods inherited from class peakml.Annotatable

addAnnotation, addAnnotation, addAnnotation, addAnnotation, addAnnotation, addAnnotations, getAnnotation, getAnnotations, removeAllAnnotations, removeAnnotation

Methods inherited from class java.lang.Object

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

Constructor Detail

FileInfo

public FileInfo(java.lang.String label,
                java.lang.String filename)

Convenience constructor, which looks up the location of the given filename in the file-system. The filename must either be as a complete path or relative from the current position.

Parameters:

label - Optional label for the file.

filename - The filename (including the complete path).

FileInfo

public FileInfo(java.lang.String label,
                java.lang.String name,
                java.lang.String location)

Constructs a new file info instance with the given values.

Parameters:

label - Optional label for the file.

name - The filename (excluding the complete path).

location - The location of the file.

Method Detail

getLabel

public java.lang.String getLabel()

Returns the optional label for the file.

Returns:

Optional label for the file.

setLabel

public void setLabel(java.lang.String label)

Sets the optional label for the file.

Parameters:

label - Optional label for the file.

getName

public java.lang.String getName()

Returns the filename excluding the complete path, which can be retrieved with getLocation().

Returns:

The filename.

setName

public void setName(java.lang.String name)

Sets the filename excluding the complete path of the file.

Parameters:

name - The filename.

getLocation

public java.lang.String getLocation()

Returns the complete path to the file.

Returns:

The complete path to the file.

setLocation

public void setLocation(java.lang.String location)

Sets the complete path to the file.

Parameters:

location - The complete path to the file.