triana.types

Class Document

java.lang.Object

triana.types.TrianaType

triana.types.Document

All Implemented Interfaces:

java.io.Serializable, AsciiComm, SequenceInterface

Direct Known Subclasses:

MailMsg

public class Document
extends TrianaType
implements AsciiComm

Document is a type which stores the contents of a Document in a String (or just encapsulates any string) with an optional file name. There are parameters for marking special lines and special groups of characters, for search-and-replace units to work with. In order to keep the line- and group-markers pointing to the same text after the contents have been modified, use the methods cutString, insertString, and replaceString. To replace the entire document and wipe out markers, use setText().

The markers for groups of characters are held in a FIFO stack, each element of which is an ArrayList of pairs of integers, marking regions of the document. Each member of the stack contains regions that are refinements of (i.e. contained within) the regions delineated in the previous element. The pointer charGroups points to the most refined level, the pointer domain points to the next most refined level. Methos allow editing units to select regions, refine them, edit them, retreat to the previous level of selection, etc.

See Also:

Serialized Form

Field Summary

Fields inherited from class triana.types.TrianaType

NOT_CONNECTED, NOT_READY, OUT_OF_RANGE

Constructor Summary

Constructors

Constructor and Description
Document() Creates a new empty Document, setting its state to false.
Document(java.lang.String contents) Creates a new Document with the contents set to the specified String.
Document(java.lang.String contents, FileName file) Creates a new Document with the contents set to the specified String and with a String representing the full path and name of the file which the Document was taken from.
Document(java.lang.String contents, java.lang.String fileAndPath) Creates a new Document with the contents set to the specified String and with a String representing the full path and name of the file which the Document was taken from.
Document(java.lang.String contents, java.lang.String file, java.lang.String directory) Creates a new Document with the contents set to the specified String, with the given name of the file from which the Document was taken, and with the given directory for the Document.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(java.lang.String insertion) Appends the given text to the existing Document.
void	addCharGroupsLayer(java.util.ArrayList cg) Sets a new ArrayList into the stack of ArrayLists containing interesting character groups and makes this new one the current one, making the previous one the domain.
void	addLine(java.lang.String text) Appends the given text to the Document and appends a further line break afterwards.
void	addLineNumber(int n) Adds an interesting line number to the line number array in the right order.
int	containedInCharGroup(int character) Returns the index of the character group containing the given character position.
int	containedInCharGroup(int character, int firstGroup) Returns the index of the character group containing the given character position, starting the search of character groups from the given group.
void	copyData(TrianaType source) Copies the Document by value from the given source, not by reference.
TrianaType	copyMe() This is one of the most important methods of Triana data.
void	copyParameters(TrianaType source) Copies modifiable parameters from the given source.
int	countLines(java.lang.String s) Counts the number of lines in the given String.
java.lang.String	cutGroupString(int index) Removes and returns the character string denoted by the given character group index.
java.lang.String	cutString(int start, int end) Removes and returns the character String between the two given index positions, including the two positions.
java.util.ArrayList	deleteCharGroups() Removes the current ArrayList of character groups, sets the next one in the stack equal to the current one, resets the domain pointer to the next one beyond that.
void	deleteLineNumber(int l) Deletes the line number at the given index location.
void	deleteLineNumbers(int start, int end) Deletes the line number range defined by the given index locations.
int	domainOfCharGroup(int cg) Returns the index of the character group in the domain ArrayList which contains the character group of the current charGroups ArrayList corresponding to the given index.
boolean	equals(java.lang.Object doc) Returns true if the specified object doc is the same type and has the same contents as this object, including the path name and file name.
boolean	existCharGroups() Tests whether there are non-trivial character group lists, not just the lowest one, which includes all characters.
int	findNext(java.lang.String text) Finds the first occurence of the given String in the Document.
int	findNext(java.lang.String text, int start) Finds the first occurence of the given String after the given character position in the Document.
int	findNextInGroup(java.lang.String text, int group) Finds the first occurence of the given String within the given character group in the Document.
int	findNextInGroup(java.lang.String text, int group, int start) Finds the first occurence of the given String within the given character group after the given location in the Document.
int[]	getCharGroup(int index) Gets the integer array for the character group denoted by the given index.
java.util.ArrayList	getCharGroups() Gets the current ArrayList of the current character groups for this Document.
java.util.ArrayList	getCharGroups(int start, int end) Returns an ArrayList of the delimiters of the character groups that are entirely contained within the given index values.
java.util.ArrayList	getCharGroupsComplement() Gets an ArrayList of int[2]'s containing the indices of the first and last characters in all parts of the document text that are not contained in the current charGroups but are contained in the current domain.
java.util.ArrayList	getCharGroupStack() Gets the whole stack of ArrayLists that denote character groups and their refinements.
java.util.ArrayList	getDomain() Returns the pointer to the domain, which is the set of character groups just above the current set in the list.
java.lang.String	getFile() Returns a string representation of the complete path and file name.
java.lang.String	getFileNoPath() Returns a String representation of the filename not including any path information.
FileName	getFileRef()
int	getFileType() Returns the filetype i.e. LOCAL (i.e. disk file) or HTTP, (on the internet).
java.lang.String	getGroupString(int group) Returns the substring defined by the character group of the given index.
int	getLineNumber(int n) Gets the nth interesting line number held for this document.
int[]	getLineNumbers() Gets the int[] array of line numbers currently held for this Document.
java.lang.String	getPath() Returns a reference to the path for this file without its filename.
java.lang.String	getString(int start, int end) Returns the substring denoted by the given character positions, inclusive.
java.lang.String	getText()
void	inputFromStream(java.io.BufferedReader dis) Used when Triana types want to be able to receive ASCII data from the output of other programs.
void	insertString(java.lang.String insertion, int location) Inserts the given character String, starting at the given character index position.
void	insertStringAsCharGroup(java.lang.String insertion, int location) Inserts the given character String at the given character index position and marks it as a character group.
boolean	isLineNumber() Tests whether there are interesting line numbers for this document.
boolean	isTextHTML()
int	length()
java.lang.String	listCharGroups() Returns a String containing the character group delimiters for the element of the character group stack at the current level.
java.lang.String	listCharGroups(int k) Returns a String containing the character group delimiters for the element of the character group stack denoted by the given index.
java.lang.String	listGroupStrings() Returns a String containing the character group delimiters and their associated group Strings at the current level.
java.lang.String	listGroupStrings(int k) Returns a String containing the character group delimiters and their associated group Strings at the level given by the integer argument.
java.lang.String	listGroupStringsNoDelims(int k) Returns a String containing the character group Strings at the level given by the integer argument.
java.lang.String	listLineNumbers() Returns a String containing the interesting line numbers, each on a separate line.
java.lang.String	listLineNumbersAndLines() Returns a String containing the interesting line numbers and their lines, separated by a line-separator (carriage-return).
int	nextCharGroup(int character) Returns the index of the first character group that starts at or after the given character position.
int	nextCharGroup(int character, int firstGroup) Returns the index of the first character group that starts at or after the given character position, starting the search of character groups from the given group.
int	nextLineNo(int n) Returns the index of the next interesting line number held in the array lineNos that is larger than the given line number, or -1 if there is no interesting line number larger.
void	outputToStream(java.io.PrintWriter dos) Used when Triana types want to be able to send ASCII data to other programs using strings.
int	prevCharGroup(int character) Returns the index of the first character group that ends at or before the given character position.
int	prevCharGroup(int character, int firstGroup) Returns the index of the first character group that ends at or before the given character position, starting the search of character groups backwards from the given group.
int	remove(java.lang.String text) Removes the first occurence of the given String from the Document.
int	remove(java.lang.String text, int start) Removes the first occurence of the given String after the given character location in the Document.
void	removeCharGroup(int index) Deletes the entry for the character group denoted by the given index.
void	removeCharGroups(int start, int finish) Deletes the int[2] arrays for all the character groups with index values between the two given values, inclusive.
int	replaceAll(java.lang.String text, java.lang.String newText) Replaces all occurences of the given String text with the given String newText.
java.lang.String	replaceGroupString(int index, java.lang.String replacement) Replaces the character group with the given index by the given String and returns the String that was removed.
int	replaceNext(java.lang.String text, java.lang.String newText) Finds the first occurence of the given String text in the Document and replaces it with the given String newText.
int	replaceNext(java.lang.String text, java.lang.String newText, int start) Finds the first occurence of the given String text after the given character location in the Document and replaces it with the given String newText.
java.lang.String	replaceString(int start, int end, java.lang.String replacement) Replaces the characters between the two given positions, inclusive, by the given String and returns the String that was replaced.
void	setCharGroup(int start, int end) Sets a new character group into the ArrayList charGroups.
void	setCharGroups(java.util.ArrayList cg) Replaces the current ArrayList of interesting character groups with this new one.
void	setFile(FileName fn) Sets the FileName data object for this Document
void	setFile(java.lang.String pn) Sets the directory and file name from an input string containing the full path to the file.
void	setLineNumbers(int[] ln) Sets an int[] array containing interesting line numbers within the file which units can use to display the file at the appropriate place(s).
void	setText(java.lang.String newContents) Sets the given String to be the contents of the object and eliminates any character group delimiters because they are unlikely to be relevant to new text.
void	shiftCharGroups(int shift, int firstGroup) Adds the given constant shift to the locations of both delimiters of all the character groups above and including the given character group.
void	shiftLineNumbers(int shift, int index) Adds a given constant shift to the interesting line numbers for this Document above the given index.
java.lang.String	toString() Provides the toString method for completeness.
protected void	updateObsoletePointers() Used to make the new types derived from TrianaType backward-compatible with older types.

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

Constructor Detail

Document

public Document()

Creates a new empty Document, setting its state to false.

Document

public Document(java.lang.String contents)

Creates a new Document with the contents set to the specified String.

Parameters:

contents - the String containing the contents of the Document.

Document

public Document(java.lang.String contents,
        java.lang.String fileAndPath)

Creates a new Document with the contents set to the specified String and with a String representing the full path and name of the file which the Document was taken from.

Parameters:

contents - the String containing the contents of the Document.

fileAndPath - the String containing the full pathname of the file where the Document came from.

Document

public Document(java.lang.String contents,
        FileName file)

Creates a new Document with the contents set to the specified String and with a String representing the full path and name of the file which the Document was taken from.

Parameters:

contents - the String containing the contents of the Document.

file - the FileName object containing the file where the Document came from.

Document

public Document(java.lang.String contents,
        java.lang.String file,
        java.lang.String directory)

Creates a new Document with the contents set to the specified String, with the given name of the file from which the Document was taken, and with the given directory for the Document.

Parameters:

contents - The contents of the Document.

file - The name of the file where the Document came from.

directory - The name of the directory where the Document came from.

Method Detail

getText

public java.lang.String getText()

Returns:

String a reference to the contents of this Document

getCharGroupStack

public java.util.ArrayList getCharGroupStack()

Gets the whole stack of ArrayLists that denote character groups and their refinements. Used for copying but not much else. There is no method to set this.

Returns:

ArrayList The stack of character group ArrayLists

setText

public void setText(java.lang.String newContents)

Sets the given String to be the contents of the object and eliminates any character group delimiters because they are unlikely to be relevant to new text. If simple modifications of the text are desired, preserving groups, use the methods cutString, insertString, replaceString, and add. Initially only one character group is defined, spanning the whole document. The pointer domain is set to null since there is only one element on the stack.

Parameters:

newContents - A string of the new contents

getString

public java.lang.String getString(int start,
                         int end)

Returns the substring denoted by the given character positions, inclusive. This does not modify the document in any way.

Parameters:

start - The location of the first character to be returned

end - The location of the last character to be returned

cutString

public java.lang.String cutString(int start,
                         int end)

Removes and returns the character String between the two given index positions, including the two positions. Returns null if either index is out of bounds. Readjusts all character group locations and interesting line numbers after the given string, so that they point to the same text as before. Any groups with delimiters inside the region to be cut are eliminated.

Parameters:

start - First character of string to be cut

end - Last character of the string to be cut

Returns:

The string that has been cut

insertString

public void insertString(java.lang.String insertion,
                int location)

Inserts the given character String, starting at the given character index position. Readjusts all character group locations and interesting line numbers after the character position, so that they point to the same text as before.

Parameters:

insertion - The character String to be inserted

location - Character index of the location of the insertion

add

public void add(java.lang.String insertion)

Appends the given text to the existing Document.

Parameters:

insertion - the String to be appended

addLine

public void addLine(java.lang.String text)

Appends the given text to the Document and appends a further line break afterwards.

Parameters:

text - the String to be appended

replaceString

public java.lang.String replaceString(int start,
                             int end,
                             java.lang.String replacement)

Replaces the characters between the two given positions, inclusive, by the given String and returns the String that was replaced. Readjusts all character group locations after the replacement, so that they point to the same text as before. Any groups with delimiters inside the region to be replaced are eliminated. Does this by calling the cutString and insertString methods.

Parameters:

start - First character to be replaced

end - Last character to be replaced

replacement - The string that is to be inserted in place of the cut string

Returns:

The portion of the document that was replaced

getFile

public java.lang.String getFile()

Returns a string representation of the complete path and file name. Note that this method returns NULL if there is no filename associated with this Document.

Returns:

String full path to file containing the Document

isTextHTML

public boolean isTextHTML()

Returns:

true if the file is a HTML file

getFileRef

public FileName getFileRef()

Returns:

the FileName Object

getFileNoPath

public java.lang.String getFileNoPath()

Returns a String representation of the filename not including any path information. Note that this method returns NULL if there is no filename associated with this Document.

Returns:

String filename (without path) of file containing Document

getPath

public java.lang.String getPath()

Returns a reference to the path for this file without its filename. Note that this method returns NULL if there is no filename associated with this Document.

Returns:

String the path (without filename) of the file containing this Document

setLineNumbers

public void setLineNumbers(int[] ln)

Sets an int[] array containing interesting line numbers within the file which units can use to display the file at the appropriate place(s). For example, this function is called by the Grep unit.

Parameters:

ln - the set of line numbers of interest

getLineNumbers

public int[] getLineNumbers()

Gets the int[] array of line numbers currently held for this Document. This is the array created by setLineNumbers, not a list of all the line numbers.

Returns:

int[] the line number array

isLineNumber

public boolean isLineNumber()

Tests whether there are interesting line numbers for this document.

Returns:

boolean True if there are non-zero line number markers

getLineNumber

public int getLineNumber(int n)

Gets the nth interesting line number held for this document. If there are not this many line numbers, returns -1.

Parameters:

n - The index into the line-number array

Returns:

int The desired line number

addLineNumber

public void addLineNumber(int n)

Adds an interesting line number to the line number array in the right order.

Parameters:

n - The line number to be added

deleteLineNumber

public void deleteLineNumber(int l)

Deletes the line number at the given index location.

Parameters:

l - The index number of the line to be deleted

deleteLineNumbers

public void deleteLineNumbers(int start,
                     int end)

Deletes the line number range defined by the given index locations.

Parameters:

start - The index number of the first line to be deleted

end - The index number of the last line to be deleted

countLines

public int countLines(java.lang.String s)

Counts the number of lines in the given String.

Parameters:

s - The String to be examined

Returns:

The number of end-of-line markers in the string

listLineNumbers

public java.lang.String listLineNumbers()

Returns a String containing the interesting line numbers, each on a separate line.

Returns:

String The list of interesting line numbers

listLineNumbersAndLines

public java.lang.String listLineNumbersAndLines()

Returns a String containing the interesting line numbers and their lines, separated by a line-separator (carriage-return).

Returns:

String The list of interesting line numbers

shiftLineNumbers

public void shiftLineNumbers(int shift,
                    int index)

Adds a given constant shift to the interesting line numbers for this Document above the given index. This allows one to ensure that the same lines are marked after lines are added to or removed from the text.

Parameters:

shift - The amount by which the line numbers are moved

index - The first line number to be moved.

nextLineNo

public int nextLineNo(int n)

Returns the index of the next interesting line number held in the array lineNos that is larger than the given line number, or -1 if there is no interesting line number larger.

Parameters:

n - The line number where the search starts

Returns:

The index of the first interesting line number above n

getCharGroups

public java.util.ArrayList getCharGroups()

Gets the current ArrayList of the current character groups for this Document. This is the ArrayList created by setCharGroups.

Returns:

ArrayList the set of integer arrays holding character ranges

getCharGroup

public int[] getCharGroup(int index)

Gets the integer array for the character group denoted by the given index. Returns null if the index is out of bounds.

Parameters:

index - the index of the character group being sought

getCharGroups

public java.util.ArrayList getCharGroups(int start,
                                int end)

Returns an ArrayList of the delimiters of the character groups that are entirely contained within the given index values. Groups that start outside and finish inside or start inside and finish outside are not included.

Parameters:

start - The index of the first character in the search interval

end - The index of the final character in the search interval

Returns:

Contains int[2] pairs of delimiters of the character groups in the search interval, null if there are none

getCharGroupsComplement

public java.util.ArrayList getCharGroupsComplement()

Gets an ArrayList of int[2]'s containing the indices of the first and last characters in all parts of the document text that are not contained in the current charGroups but are contained in the current domain. This allows units to search the domain to create further new charGroups at the same level as the current one. If the domain is totally subdivided into groups, then the method returns null.

Returns:

ArrayList Contains int[2] pairs marking text in current domain not in current charGroups, or null

addCharGroupsLayer

public void addCharGroupsLayer(java.util.ArrayList cg)

Sets a new ArrayList into the stack of ArrayLists containing interesting character groups and makes this new one the current one, making the previous one the domain.

Parameters:

cg - the set of integer arrays holding character ranges

setCharGroups

public void setCharGroups(java.util.ArrayList cg)

Replaces the current ArrayList of interesting character groups with this new one. If there is not layer apart from the base layer, then this adds a new one.

Parameters:

cg - the set of integer arrays holding character ranges

existCharGroups

public boolean existCharGroups()

Tests whether there are non-trivial character group lists, not just the lowest one, which includes all characters.

Returns:

boolean True if there is more than one layer of character group lists

setCharGroup

public void setCharGroup(int start,
                int end)

Sets a new character group into the ArrayList charGroups. The group is delineated by the given start and end character positions. It is placed in the ArrayList in the correct place to be in sequence with other character groups as they appear in the text. If the range overlaps with one or more existing groups, the old groups are eliminated. This only affects character group pointers; it does not change the document text string at all.

Parameters:

start - the integer beginning the range for this group

end - the integer ending the range for this group

removeCharGroup

public void removeCharGroup(int index)

Deletes the entry for the character group denoted by the given index. This only affects character group pointers; it does not change the document text string at all.

Parameters:

index - the index of the character group being deleted

removeCharGroups

public void removeCharGroups(int start,
                    int finish)

Deletes the int[2] arrays for all the character groups with index values between the two given values, inclusive. This only affects character group pointers; it does not change the document text string at all.

Parameters:

start - the index of the first character group being deleted

finish - the index of the final character group being deleted

deleteCharGroups

public java.util.ArrayList deleteCharGroups()

Removes the current ArrayList of character groups, sets the next one in the stack equal to the current one, resets the domain pointer to the next one beyond that. Will not remove the last character group, which spans the whole document; in this case the method returns null.

Returns:

ArrayList The removed ArrayList

getDomain

public java.util.ArrayList getDomain()

Returns the pointer to the domain, which is the set of character groups just above the current set in the list. The model assumes that the current set are obtained by refinement of the ones pointed to by domain. Thus, an editing unit creating selections at the current level will search only within selections in the domain. There is no method to set this pointer. That happens automatically when the stack of character group sets changes.

Returns:

ArrayList The list referenced by the domain pointer

shiftCharGroups

public void shiftCharGroups(int shift,
                   int firstGroup)

Adds the given constant shift to the locations of both delimiters of all the character groups above and including the given character group. This allows resetting of the locations of the character groups after the document has changed length. This only affects character group pointers; it does not change the document text string at all.

Parameters:

shift - The amount to increment delimiters of character groups

firstGroup - The index of the first group to be shifted

containedInCharGroup

public int containedInCharGroup(int character,
                       int firstGroup)

Returns the index of the character group containing the given character position, starting the search of character groups from the given group. If the given character is not contained in a group in the search, returns -1.

Parameters:

character - The index in the document of the character being tested

firstGroup - The index of the character group at which the search starts

Returns:

The index of the character group containing the character, or -1 if there is none

containedInCharGroup

public int containedInCharGroup(int character)

Returns the index of the character group containing the given character position. If the given character is not contained in a group in the search, returns -1.

Parameters:

character - The index in the document of the character being tested

Returns:

The index of the character group containing the character, or -1 if there is none

nextCharGroup

public int nextCharGroup(int character,
                int firstGroup)

Returns the index of the first character group that starts at or after the given character position, starting the search of character groups from the given group. If no character group is found in the search, returns -1. If the given character is in a character group, the index of the next group is returned.

Parameters:

character - The index in the document of the character being tested

firstGroup - The index of the character group at which the search starts

Returns:

The index of the first character group starting after the character, or -1 if there is none

nextCharGroup

public int nextCharGroup(int character)

Returns the index of the first character group that starts at or after the given character position. If no character group is found in the search, returns -1. If the given character is in a character group, the index of the next group is returned.

Parameters:

character - The index in the document of the character being tested

Returns:

The index of the first character group starting after the character, or -1 if there is none

prevCharGroup

public int prevCharGroup(int character,
                int firstGroup)

Returns the index of the first character group that ends at or before the given character position, starting the search of character groups backwards from the given group.

If no character group is found in the search, returns -1. If the given character is at the end of a character group, the index of that group is returned. If the given character is in a character group but is not the last character of the group, the index of the next group before it is returned.

Parameters:

character - The index in the document of the character being tested

firstGroup - The index of the character group at which the search starts

Returns:

int The index of the first character group ending at or before the character, or -1 if there is none

prevCharGroup

public int prevCharGroup(int character)

Returns the index of the first character group that ends at or before the given character position.

If no character group is found in the search, returns -1. If the given character is at the end of a character group, the index of that group is returned. If the given character is in a character group but is not the last character of the group, the index of the next group before it is returned.

Parameters:

character - The index in the document of the character being tested

Returns:

int The index of the first character group ending at or before the character, or -1 if there is none

domainOfCharGroup

public int domainOfCharGroup(int cg)

Returns the index of the character group in the domain ArrayList which contains the character group of the current charGroups ArrayList corresponding to the given index.

Parameters:

cg - The index of the character group in the current list

Returns:

The index of the character group in the domain list that contains the given group

getGroupString

public java.lang.String getGroupString(int group)

Returns the substring defined by the character group of the given index. This does not modify the string or the character group locations.

Parameters:

group - Index of the group to be returned

Returns:

String The substring defined by the group

listCharGroups

public java.lang.String listCharGroups(int k)

Returns a String containing the character group delimiters for the element of the character group stack denoted by the given index. The pairs are written all on one line.

Parameters:

k - The level in the character group stack to be written

Returns:

The character group delimiters

listCharGroups

public java.lang.String listCharGroups()

Returns a String containing the character group delimiters for the element of the character group stack at the current level. The pairs are written all on one line.

Returns:

String The character group delimiters

listGroupStrings

public java.lang.String listGroupStrings(int k)

Returns a String containing the character group delimiters and their associated group Strings at the level given by the integer argument. The groups are separated by blank lines.

Parameters:

k - The level in the character group stack to be written

Returns:

The character group Strings and delimiters

listGroupStringsNoDelims

public java.lang.String listGroupStringsNoDelims(int k)

Returns a String containing the character group Strings at the level given by the integer argument. The groups are separated by blank lines.

Parameters:

k - The level in the character group stack to be written

Returns:

The character group Strings

listGroupStrings

public java.lang.String listGroupStrings()

Returns a String containing the character group delimiters and their associated group Strings at the current level. The groups are separated by blank lines.

Returns:

String The character group delimiters

cutGroupString

public java.lang.String cutGroupString(int index)

Removes and returns the character string denoted by the given character group index. Readjusts all subsequent character group locations after the cut so that they point to the same text as before the removal.

Parameters:

index - Index of the character group to be cut

Returns:

the string that has been cut

insertStringAsCharGroup

public void insertStringAsCharGroup(java.lang.String insertion,
                           int location)

Inserts the given character String at the given character index position and marks it as a character group. Readjusts all character group locations after the character position, so that they point to the same text as before the insertion. If the insertion occurs within a character group, that group is eliminated and the insertion is made into a new character group. If insertion into an existing group is desired, use instead the method insertString.

Parameters:

insertion - The character String to be inserted

location - Character index of the location of the insertion

replaceGroupString

public java.lang.String replaceGroupString(int index,
                                  java.lang.String replacement)

Replaces the character group with the given index by the given String and returns the String that was removed. Readjusts all character group locations after the replacement, so that they point to the same text as before. The character group with the given index is readjusted in size to delimit the new replacement substring.

Parameters:

index - Index of the character group to be replaced

replacement - The string that is to be inserted in place of the cut string

Returns:

The portion of the document that was replaced

getFileType

public int getFileType()

Returns the filetype i.e. LOCAL (i.e. disk file) or HTTP, (on the internet). See FileName for definitions of HTTP and LOCAL.

If there is no file name attached to this Document then this returns the FileName.INVALID flag.

Returns:

int the filetype

See Also:

FileName

setFile

public void setFile(FileName fn)

Sets the FileName data object for this Document

Parameters:

fn - The full path to the given file

setFile

public void setFile(java.lang.String pn)

Sets the directory and file name from an input string containing the full path to the file.

Parameters:

pn - The full path to the given file

length

public int length()

Returns:

int the length of this Document

findNext

public int findNext(java.lang.String text)

Finds the first occurence of the given String in the Document. It returns the position of the string or -1 if it is not present.

Parameters:

text - The text to search for

Returns:

the first position of the given string within the Document

findNext

public int findNext(java.lang.String text,
           int start)

Finds the first occurence of the given String after the given character position in the Document. It returns the position of the string or -1 if it is not present.

Parameters:

text - The text to search for

start - Index of first character of the search

Returns:

the first position of the given string after start within the Document

findNextInGroup

public int findNextInGroup(java.lang.String text,
                  int group)

Finds the first occurence of the given String within the given character group in the Document. It returns the position of the string or -1 if it is not present in the group.

Parameters:

text - The text to search for

group - Index of character group of the search

Returns:

the first position of the given string after start within the Document

findNextInGroup

public int findNextInGroup(java.lang.String text,
                  int group,
                  int start)

Finds the first occurence of the given String within the given character group after the given location in the Document. It returns the position of the string or -1 if it is not present in the group after the given location. If the index start is not within the group, the method returns -2.

Parameters:

text - The text to search for

group - Index of character group of the search

start - Index of the first character of the search

Returns:

the first position of the given string after start within the Document

remove

public int remove(java.lang.String text)

Removes the first occurence of the given String from the Document. It returns the position of the string or -1 if it is not present.

Parameters:

text - The text to search for

Returns:

the first position of the given string within the Document

remove

public int remove(java.lang.String text,
         int start)

Removes the first occurence of the given String after the given character location in the Document. It returns the position of the string or -1 if it is not present.

Parameters:

text - The text to search for

Returns:

the first position of the given string within the Document

replaceNext

public int replaceNext(java.lang.String text,
              java.lang.String newText)

Finds the first occurence of the given String text in the Document and replaces it with the given String newText. Returns -1 if the Document does not contain text.

Parameters:

text - The text to search for

newText - The text to insert in place of text

Returns:

the first position of the text within the Document

replaceNext

public int replaceNext(java.lang.String text,
              java.lang.String newText,
              int start)

Finds the first occurence of the given String text after the given character location in the Document and replaces it with the given String newText. Returns -1 if the Document does not contain text.

Parameters:

text - The text to search for

newText - The text to insert in place of text

Returns:

the first position of the text within the Document

replaceAll

public int replaceAll(java.lang.String text,
             java.lang.String newText)

Replaces all occurences of the given String text with the given String newText.

Parameters:

text - The text to search for

newText - The text to insert in place of text

Returns:

int The number of replacements that were made

equals

public boolean equals(java.lang.Object doc)

Returns true if the specified object doc is the same type and has the same contents as this object, including the path name and file name. Does not test character group pointers or line number lists.

Overrides:

equals in class java.lang.Object

Returns:

Boolean true if the argument is a Document with the same contents as this Document

copyMe

public TrianaType copyMe()

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:

TrianaType Copy by value of the current Object except for an updated description

copyData

public void copyData(TrianaType source)

Copies the Document by value from the given source, not by reference.

Overrides:

copyData in class TrianaType

Parameters:

source - The Document object being copied

copyParameters

public void copyParameters(TrianaType source)

Copies modifiable parameters from the given source.

Overrides:

copyParameters in class TrianaType

Parameters:

source - The Document object being copied

outputToStream

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

Used when Triana types want to be able to send ASCII data to other programs using strings. This is used to implement socket and to run other executables, written in C or other languages. With ASCII you don't have to worry about ENDIAN'ness as the conversions are all done via text. This is obviously slower than binary communication since you have to format the input and output within the other 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

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 or other languages. With ASCII you don't have to worry about ENDIAN'ness as the conversions are all done via text. This is obviously slower than binary communication since you have to format the input and output within the other 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()

Used to make the new types derived from TrianaType backward-compatible with older types. It must be called by any method that modifies data in dataContainer or in any other variable that replaces a storage location used previously by any type. It must be implemented (over-ridden) in any type that re-defines storage or access methods to any variable. The implementation should assign the new variables to the obsolete ones, and ensure that obsolete access methods retrieve data from the new locations. Any over-riding method should finish with the line

 super.updateObsoletePointers; 

Overrides:

updateObsoletePointers in class TrianaType

toString

public java.lang.String toString()

Provides the toString method for completeness. Synonym for getText.

Overrides:

toString in class java.lang.Object

Returns:

String the contents of this Document