triana.types

Class FileName

java.lang.Object

triana.types.TrianaType

triana.types.FileName

All Implemented Interfaces:

java.io.Serializable, AsciiComm, SequenceInterface

public class FileName
extends TrianaType
implements AsciiComm

FileName is a type which encapsulates a file name whether it be a local disk file or an internet file. It is represented by a String and you can determine what type it is by calling the getFileType() function. This returns LOCAL if its a disk file or HTTP if it is a HTTP protocol file.

The motivation behind this class is to deal simply with these two file types so that triana can import data from the internet as transparently as a local disk file. These are the only real protocols we use. I'm sure there are others but we've not included them here.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	HTTP
static int	INVALID
static int	LOCAL

Fields inherited from class triana.types.TrianaType

NOT_CONNECTED, NOT_READY, OUT_OF_RANGE

Constructor Summary

Constructors

Constructor and Description
FileName() Creates a new empty FileName.
FileName(java.io.File fn) Creates a new FileName from another File object
FileName(java.lang.String fn) Creates a new FileName from a string containing the full path and name of the file.
FileName(java.lang.String path, java.lang.String fn) Creates a new FileName from a string containing the specified path and name of the file.
FileName(java.net.URL url)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(FileName fn) Adds the filename to the list of filenames.
void	copyData(TrianaType source) This method does nothing here, but is required by TrianaType.
TrianaType	copyMe() This is one of the most important methods of Triana data.
void	copyParameters(TrianaType source) Method to copy the data for this class.
boolean	equals(java.lang.Object fn) This function returns true if the specified object fn is the same type and has the same contents as this object
FileName	get(int i) Gets the ith filename in this list of filenames.
java.lang.String	getDocumentTitle()
java.lang.String	getFile()
java.lang.String	getFileNoPath() Returns a reference to this FileName not including any path information
int	getFileType()
static java.lang.String	getHTMLTitle(java.lang.String fn)
int[]	getLineNumbers() Gets the line number within this file
java.lang.String	getPath() Returns a reference to the path of this file name
boolean	hasMultiple()
void	inputFromStream(java.io.BufferedReader dis) This function is used when Triana types want to be able to receive ASCII data from the output of other programs.
static boolean	isHTTP(java.lang.String file)
void	outputToStream(java.io.PrintWriter dos) This function is used when Triana types want to be able to send their data via an output stream to other programs using strings.
void	setFile(java.lang.String file) Sets the file to the given string and works out if its a HTTP address or not
void	setLineNumbers(int[] ln) Sets the interesting line numbers within the file which units can use to display the file at the appropriate place.
int	size() Gets the number of filenames in list filenames.
java.lang.String	toString()
protected void	updateObsoletePointers()

Methods inherited from class triana.types.TrianaType

containerSize, dataExists, deleteFromContainer, getDataContainer, getFromContainer, getSequenceNumber, insertIntoContainer, inspectDataContainer, setDataContainer, setSequenceNumber

Methods inherited from class java.lang.Object

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

Field Detail

INVALID

public static final int INVALID

See Also:

Constant Field Values

LOCAL

public static final int LOCAL

See Also:

Constant Field Values

HTTP

public static final int HTTP

See Also:

Constant Field Values

Constructor Detail

FileName

public FileName()

Creates a new empty FileName.

FileName

public FileName(java.lang.String fn)

Creates a new FileName from a string containing the full path and name of the file.

Parameters:

fn - the full path and name of file.

FileName

public FileName(java.lang.String path,
        java.lang.String fn)

Creates a new FileName from a string containing the specified path and name of the file.

Parameters:

path - the full path.

fn - name of file.

FileName

public FileName(java.io.File fn)

Creates a new FileName from another File object

Parameters:

fn - a file object representing the file.

FileName

public FileName(java.net.URL url)

Method Detail

add

public void add(FileName fn)

Adds the filename to the list of filenames. Upon creation of a FileName there is one object in this list of this fileName object

hasMultiple

public boolean hasMultiple()

Returns:

true if this filename object stores a list of filenames

get

public FileName get(int i)

Gets the ith filename in this list of filenames.

size

public int size()

Gets the number of filenames in list filenames.

setLineNumbers

public void setLineNumbers(int[] ln)

Sets the interesting line numbers within the file which units can use to display the file at the appropriate place. For example, this function is called by the Grep unit.

getLineNumbers

public int[] getLineNumbers()

Gets the line number within this file

isHTTP

public static boolean isHTTP(java.lang.String file)

setFile

public void setFile(java.lang.String file)

Sets the file to the given string and works out if its a HTTP address or not

getFile

public java.lang.String getFile()

Returns:

the full file and path

getDocumentTitle

public java.lang.String getDocumentTitle()

Returns:

the document title of this file name. If this file name is a html file then it returns the title of this file otherwise it returns the name of the file without the directory.

getHTMLTitle

public static java.lang.String getHTMLTitle(java.lang.String fn)

Returns:

the document title of this file name. If this file name is a html file then it returns the title of this file otherwise it returns the name of the file without the directory.

getFileNoPath

public java.lang.String getFileNoPath()

Returns a reference to this FileName not including any path information

getPath

public java.lang.String getPath()

Returns a reference to the path of this file name

getFileType

public int getFileType()

Returns:

the filetype i.e. LOCAL (i.e. disk file) or HTTP, (on the internet).

equals

public boolean equals(java.lang.Object fn)

This function returns true if the specified object fn is the same type and has the same contents as this object

Overrides:

equals in class java.lang.Object

copyMe

public TrianaType copyMe()

Description copied from class: TrianaType

This is one of the most important methods of Triana data. types. It returns a copy of the type invoking it. This must be overridden for every derived data type derived. If not, the data cannot be copied to be given to other units. Copying must be done by value, not by reference.

To override, the programmer should not invoke the super.copyMe method. Instead, create an object of the current type and call methods copyData and copyParameters. If these have been written correctly, then they will do the copying. The code should createTool, for type YourType:

 YourType y = null; try { y =
 (YourType)getClass().newInstance(); y.copyData( this ); y.copyParameters( this ); y.setLegend( this.getLegend()
 ); } catch (IllegalAccessException ee) { System.out.println("Illegal Access: " + ee.getMessage()); } catch
 (InstantiationException ee) { System.out.println("Couldn't be instantiated: " + ee.getMessage()); } return y;
 

The copied object's data should be identical to the original. The method here modifies only one item: a String indicating that the object was created as a copy is added to the description StringVector.

Specified by:

copyMe in class TrianaType

Returns:

a copy of a FileName. This must be implemented for every TrianaType.

See Also:

TrianaType.copyMe()

copyData

public void copyData(TrianaType source)

This method does nothing here, but is required by TrianaType.

Overrides:

copyData in class TrianaType

Parameters:

source - The object being copied from

copyParameters

public void copyParameters(TrianaType source)

Method to copy the data for this class. Copies by value, not reference.

Overrides:

copyParameters in class TrianaType

Parameters:

source - The object being copied from

outputToStream

public void outputToStream(java.io.PrintWriter dos)
                    throws java.io.IOException

This function is used when Triana types want to be able to send their data via an output stream to other programs using strings. This can be used to implement socket and to run other executables, written in C etc. With ASCII you don'y have to worry about ENDIAN'ness as the conversions are all done via text. This is obviously slower than the binary version since you have to format the input and output within the another program.

This method must be overridden in every subclass that defines new data or parameters. The overriding method should first call

 super.outputToStream(dos) 

to get output from superior classes, and then new parameters defined for the current subclass must be output. Moreover, subclasses that first dimension their data arrays must explicitly transfer these data arrays.

Specified by:

outputToStream in interface AsciiComm

Parameters:

dos - The data output stream

Throws:

java.io.IOException

inputFromStream

public void inputFromStream(java.io.BufferedReader dis)
                     throws java.io.IOException

This function is used when Triana types want to be able to receive ASCII data from the output of other programs. This is used to implement socket and to run other executables, written in C etc. With ASCII you don'y have to worry about ENDIAN'ness as the conversions are all done via text. This is obviously slower than the binary version since you have to format the input and output within the another program.

This method must be overridden in every subclass that defines new data or parameters. The overriding method should first call

 super.inputFromStream(dis) 

to get input from superior classes, and then new parameters defined for the current subclass must be input. Moreover, subclasses that first dimension their data arrays must explicitly transfer these data arrays.

Specified by:

inputFromStream in interface AsciiComm

Parameters:

dis - The data input stream

Throws:

java.io.IOException

updateObsoletePointers

protected void updateObsoletePointers()

Overrides:

updateObsoletePointers in class TrianaType

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object