A B C D E F G H J L M O P Q R S T X

A

Add(String, T) - Method in class xml2fol.MapList
Adds element to MapList using key
Add(long, T) - Method in class xml2fol.MapList
Adds element to MapList using key
AddFile(String) - Method in class xml2fol.FOLTable
Adds a given xmlfile (and all its xpaths) to the table

B

BinarySearch(Vector, Object, Comparator) - Static method in class xml2fol.Global
A standard binary search program that returns the index of a given object in a vector

C

Clear() - Method in class xml2fol.MapList
Clears the values in the list and map
ClearCollection() - Method in class xml2fol.FOLTable
Clears the values in the collection
ClearIndex() - Method in class xml2fol.OLEngine
Clears the index
ClearList() - Method in class xml2fol.OLEngine
Clears the table
Close() - Method in class xml2fol.OLEngine
Clears the table and index files
CloseTable() - Method in class xml2fol.FOLTable
Closes the tables
CMDLINE_AGRGUMENT_DELIM - Static variable in class xml2fol.Global
Deliminator for command line aruguments
CMDLINE_KEYVALUE_DELIM - Static variable in class xml2fol.Global
Deliminator for key,values paris in command line aruguments
ContainsKey(String) - Method in class xml2fol.MapList
Determines if MapList contains a specified key
ContainsKey(long) - Method in class xml2fol.MapList
Determines if MapList contains a specified key
ConvertXML(String) - Method in class xml2fol.XML2FOL
Public interface.
CopyMapToList() - Method in class xml2fol.MapList
Copies all the values in the map to the list
CopyRecursive(String, String) - Static method in class xml2fol.FileUtil
A method that copied files from one location to another.
CreateCollection() - Method in class xml2fol.XML2FOL
 
CreateDirsNotExists(String) - Static method in class xml2fol.FileUtil
Creates the directory structure for a filename if it does not alreay exist
CreateMirrorDirsNotExists(String, String) - Static method in class xml2fol.FileUtil
Creates a mirror set of sub directories in a source directory in a destination directory

D

DEFAULT_XPATH_VALUE - Static variable in class xml2fol.Global
default xpath value
DeleteRecursive(String) - Static method in class xml2fol.FileUtil
A method that deletes files.

E

ERROR_FILENAME - Static variable in class xml2fol.Global
global error file filename

F

FilesExist() - Method in class xml2fol.OLEngine
 
FileUtil - Class in xml2fol
A class that performs comman file utilities
FileUtil() - Constructor for class xml2fol.FileUtil
 
FOL_DELIM - Static variable in class xml2fol.Global
Delimator for FOL documents
FOL_SUFFIX - Static variable in class xml2fol.Global
Suffix for file,offset,length documents
FOLTable - Class in xml2fol
 
FOLTable(String, String, boolean) - Constructor for class xml2fol.FOLTable
Creates an FOLTable with the following parameters No Index Filename (filename is empty string) Values are stored in both Map and List Min character length is 0
FOLTable(String, String, String, boolean) - Constructor for class xml2fol.FOLTable
Creates an FOLTable with the following parameters Values are stored in both Map and List Min character length is 0
FOLTable(String, String, int, boolean) - Constructor for class xml2fol.FOLTable
Creates an FOLTable with the following parameters No Index Filename (filename is empty string) Values are stored in both Map and List
FOLTable(String, String, String, int, boolean) - Constructor for class xml2fol.FOLTable
Creates an FOLTable with the following parameters Values are stored in both Map and List
FOLTable(String, String, boolean, boolean, boolean) - Constructor for class xml2fol.FOLTable
Creates an FOLTable with the following parameters Min character length is 0 No Index Filename (filename is empty string)
FOLTable(String, String, String, boolean, boolean, boolean) - Constructor for class xml2fol.FOLTable
Creates an FOLTable with the following parameters Min character length is 0
FOLTable(String, String, int, boolean, boolean, boolean) - Constructor for class xml2fol.FOLTable
Creates an FOLTable with the following parameters No Index Filename (filename is empty string)
FOLTable(String, String, String, int, boolean, boolean, boolean) - Constructor for class xml2fol.FOLTable
Creates an FOLTable with the following parameters

G

GetHashKey(String, String) - Static method in class xml2fol.Global
a utility method that produces a unique key for a given filename and xpath Used to ensure that keys are kept consistant throughout the program Key is returned as a number derived via MD5 hash algorithm
GetJustFileName(String) - Static method in class xml2fol.Global
a utility method that for a given will just the name of the file when given a given a complete filepath e.g.
GetKey(String, String) - Static method in class xml2fol.Global
a utility method that produces a unique key for a given filename and xpath Used to ensure that keys are kept consistant throughout the program
GetListSize() - Method in class xml2fol.MapList
Returns the number of elements in the list
GetListString() - Method in class xml2fol.FOLTable
Returns all the values in the table as a string
GetListText() - Method in class xml2fol.MapList
Return all text in the list
GetListToString() - Method in class xml2fol.OLEngine
Returns the entire list as a string
GetMapSize() - Method in class xml2fol.MapList
Returns the number of elements in the map
GetMD5(String) - Static method in class xml2fol.MD5
MD5-Hash erzeugen
getRecordUsingTable(String, String) - Method in class xml2fol.OLEngine
Gets the offset and length for a particular element
GetStoreList() - Method in class xml2fol.MapList
Returns the value of the storeList
GetStoreMap() - Method in class xml2fol.MapList
Returns the value of the storeMap
GetUsingIndex(int) - Method in class xml2fol.MapList
Gets an element from the MapList using the key
GetUsingKey(String) - Method in class xml2fol.MapList
Gets an element from the MapList using the key
GetUsingKey(long) - Method in class xml2fol.MapList
Gets an element from the MapList using the key
Global - Class in xml2fol
A utility class that contains common constant and methods that can be called from the other classes.
Global() - Constructor for class xml2fol.Global
 

H

hash(int, boolean) - Static method in class xml2fol.HashCodeUtil
Produces hash for booleans.
hash(int, char) - Static method in class xml2fol.HashCodeUtil
Produces hash for chars.
hash(int, int) - Static method in class xml2fol.HashCodeUtil
Produces hash for integers.
hash(int, long) - Static method in class xml2fol.HashCodeUtil
Produces hash for longs.
hash(int, float) - Static method in class xml2fol.HashCodeUtil
Produces hash for floats.
hash(int, double) - Static method in class xml2fol.HashCodeUtil
Produces hash for doubles.
hash(int, Object) - Static method in class xml2fol.HashCodeUtil
aObject is a possibly-null object field, and possibly an array.
HashCodeUtil - Class in xml2fol
The following utility class allows simple construction of an effective hashCode method.
HashCodeUtil() - Constructor for class xml2fol.HashCodeUtil
 
HTML_SUFFIX - Static variable in class xml2fol.Global
Suffix for HTML documents

J

JPG_SUFFIX - Static variable in class xml2fol.Global
Suffix for JPG images

L

LoadIndex(boolean, boolean) - Method in class xml2fol.FOLTable
Loads the values from the index into memory
LoadIndex() - Method in class xml2fol.OLEngine
Loads the index
LoadList() - Method in class xml2fol.OLEngine
Loads the table into memory
LoadSingleList(String) - Method in class xml2fol.OLEngine
Loads the table for a single file into memory NB Index needs to be loaded for the function to be able to load the details of a single document

M

main(String[]) - Static method in class xml2fol.XML2FOL
 
MapList<T> - Class in xml2fol
A utlity class that contains both a map (vector) and a list (hashtable) for a given data type.
MapList() - Constructor for class xml2fol.MapList
Creates a MapList that keeps information in both Map and List and without a comparator.
MapList(Comparator) - Constructor for class xml2fol.MapList
Creates a MapList that keeps information in both Map and List and with a comparator c.
MapList(boolean, boolean) - Constructor for class xml2fol.MapList
Creates a MapList that the appropriate storeMap and storeList values and without a comparator.
MapList(boolean, boolean, Comparator) - Constructor for class xml2fol.MapList
Creates a MapList that the appropriate storeMap and storeList values and with a comparator c.
MapList(boolean, boolean, Comparator, int) - Constructor for class xml2fol.MapList
Creates a MapList of specified size that the appropriate storeMap and storeList values and with a comparator c.
MD5 - Class in xml2fol
MD5-Klasse, zum erzeugen von MD5-Hashes aus Zeichenketten

Class: MD5

Java-Version: 1.5x

© Copyright: Karsten Bettray - 2006

License: Free for non commercial use, for all educational institutions (Schools, Universities ...) and it members
MD5() - Constructor for class xml2fol.MD5
 
MoveRecursive(String, String) - Static method in class xml2fol.FileUtil
A method that moves files from one location to another.

O

OLEngine - Class in xml2fol
A class that abstractly handles the processing of passages within documents The class is able to load information from the tables on disk regardless of the type of table saved.
OLEngine(String, String) - Constructor for class xml2fol.OLEngine
Produces a OLEngine with the specified table filename, table flag and stores values both in the map and list.
OLEngine(String, String, String) - Constructor for class xml2fol.OLEngine
Produces a OLEngine with the specified table filename, index filename, table flag and stores values both in the map and list
OLEngine(String, String, String, boolean, boolean) - Constructor for class xml2fol.OLEngine
Produces a OLEngine with the specified table filename, index filename, table flag and store map/list values
Open() - Method in class xml2fol.OLEngine
Opens the table and index files
OpenTable() - Method in class xml2fol.FOLTable
Opens the tables

P

PopulateCollection(String, boolean, boolean) - Method in class xml2fol.FOLTable
This method loads the details of a particular document it assumes that index is loaded
PrintCollection() - Method in class xml2fol.FOLTable
Prints the values in the table to the screen
PrintIndex() - Method in class xml2fol.FOLTable
Prints the index to the screen
PrintList() - Method in class xml2fol.MapList
Outputs all text in the list to the screen
PrintStatusMessage() - Static method in class xml2fol.XML2FOL
Prints a status message on how to use this program
ProcessArguments(String[]) - Method in class xml2fol.XML2FOL
Proceses the command line arguments
ProcessCommandsLinrArguments(String[]) - Static method in class xml2fol.Global
Populates a hashtable with a set of command line arguments and values (in lower case) arguments should be in -key=value format otherwise entire argument will be returned as the key with a empty string as its value

Q

QRL_SUFFIX - Static variable in class xml2fol.Global
Suffix for GPXRai Log documents

R

ReportProgress(int, int, int) - Static method in class xml2fol.Global
Reports progress the amount of progress that has been made is signifcant
ReportProgress(long, long, long) - Static method in class xml2fol.Global
Reports progress the amount of progress that has been made is signifcant
ResortTable() - Method in class xml2fol.FOLTable
Sorts a table

S

SEED - Static variable in class xml2fol.HashCodeUtil
An initial value for a hashCode, to which is added contributions from fields.
SetErrorFilename(String) - Static method in class xml2fol.Global
Sets the filename of the global error file
SetStoreList(boolean) - Method in class xml2fol.MapList
Sets the value of the storeList
SetStoreMap(boolean) - Method in class xml2fol.MapList
Sets the value of the storeMap
Sort() - Method in class xml2fol.MapList
Sorts the list if a valid comparator is advailable

T

TXT_SUFFIX - Static variable in class xml2fol.Global
Suffix for text documents

X

xml2fol - package xml2fol
 
XML2FOL - Class in xml2fol
This is a class that saves the offsets and lengths (in bytes) for each of the elements in collection.
XML2FOL() - Constructor for class xml2fol.XML2FOL
Creates a XMl2FOL object without an input, table or index value, only saves values to the list (not the map), sets the minimum length to 0, saves text elements in the table sets the table type to binary, and sets sort to false.
XML_SUFFIX - Static variable in class xml2fol.Global
Suffix for XML documents
XML_SUFFIX_LENGTH - Static variable in class xml2fol.Global
Number of characters in XML suffix

A B C D E F G H J L M O P Q R S T X