xml2fol
Class FOLTable

java.lang.Object
  extended by xml2fol.FOLTable

public class FOLTable
extends java.lang.Object


Constructor Summary
FOLTable(java.lang.String fxolFilename, java.lang.String tableFlag, boolean saveText)
          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(java.lang.String fxolFilename, java.lang.String tableFlag, boolean storeMap, boolean storeList, boolean saveText)
          Creates an FOLTable with the following parameters Min character length is 0 No Index Filename (filename is empty string)
FOLTable(java.lang.String fxolFilename, java.lang.String tableFlag, int minCharacterLength, boolean saveText)
          Creates an FOLTable with the following parameters No Index Filename (filename is empty string) Values are stored in both Map and List
FOLTable(java.lang.String fxolFilename, java.lang.String tableFlag, int minCharacterLength, boolean storeMap, boolean storeList, boolean saveText)
          Creates an FOLTable with the following parameters No Index Filename (filename is empty string)
FOLTable(java.lang.String fxolFilename, java.lang.String idxFilename, java.lang.String tableFlag, boolean saveText)
          Creates an FOLTable with the following parameters Values are stored in both Map and List Min character length is 0
FOLTable(java.lang.String fxolFilename, java.lang.String idxFilename, java.lang.String tableFlag, boolean storeMap, boolean storeList, boolean saveText)
          Creates an FOLTable with the following parameters Min character length is 0
FOLTable(java.lang.String fxolFilename, java.lang.String idxFilename, java.lang.String tableFlag, int minCharacterLength, boolean saveText)
          Creates an FOLTable with the following parameters Values are stored in both Map and List
FOLTable(java.lang.String fxolFilename, java.lang.String idxFilename, java.lang.String tableFlag, int minCharacterLength, boolean storeMap, boolean storeList, boolean saveText)
          Creates an FOLTable with the following parameters
 
Method Summary
 int AddFile(java.lang.String xmlfilename)
          Adds a given xmlfile (and all its xpaths) to the table
 void ClearCollection()
          Clears the values in the collection
 void CloseTable()
          Closes the tables
 java.lang.String GetListString()
          Returns all the values in the table as a string
 void LoadIndex(boolean storeMap, boolean storeList)
          Loads the values from the index into memory
 void OpenTable()
          Opens the tables
 void PopulateCollection(java.lang.String xmlfilename, boolean storeMap, boolean storeList)
          This method loads the details of a particular document it assumes that index is loaded
 void PrintCollection()
          Prints the values in the table to the screen
 void PrintIndex()
          Prints the index to the screen
 void ResortTable()
          Sorts a table
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FOLTable

public FOLTable(java.lang.String fxolFilename,
                java.lang.String tableFlag,
                boolean saveText)
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

Parameters:
fxolFilename - - The name of the FOL table
tableFlag - - A flag to indicate the type of table created
saveText - - A flag to indicate if text elements should be stored in the table

FOLTable

public FOLTable(java.lang.String fxolFilename,
                java.lang.String idxFilename,
                java.lang.String tableFlag,
                boolean saveText)
Creates an FOLTable with the following parameters Values are stored in both Map and List Min character length is 0

Parameters:
fxolFilename - - The name of the FOL table
idxFilename - - The name of the FOL table's index
tableFlag - - A flag to indicate the type of table created
saveText - - A flag to indicate if text elements should be stored in the table

FOLTable

public FOLTable(java.lang.String fxolFilename,
                java.lang.String tableFlag,
                int minCharacterLength,
                boolean saveText)
Creates an FOLTable with the following parameters No Index Filename (filename is empty string) Values are stored in both Map and List

Parameters:
fxolFilename - - The name of the FOL table
tableFlag - - A flag to indicate the type of table created
minCharacterLength - - The minimum character length required for elements to be stored in the table
saveText - - A flag to indicate if text elements should be stored in the table

FOLTable

public FOLTable(java.lang.String fxolFilename,
                java.lang.String idxFilename,
                java.lang.String tableFlag,
                int minCharacterLength,
                boolean saveText)
Creates an FOLTable with the following parameters Values are stored in both Map and List

Parameters:
fxolFilename - - The name of the FOL table
idxFilename - - The name of the FOL table's index
tableFlag - - A flag to indicate the type of table created
minCharacterLength - - The minimum character length required for elements to be stored in the table
saveText - - A flag to indicate if text elements should be stored in the table

FOLTable

public FOLTable(java.lang.String fxolFilename,
                java.lang.String tableFlag,
                boolean storeMap,
                boolean storeList,
                boolean saveText)
Creates an FOLTable with the following parameters Min character length is 0 No Index Filename (filename is empty string)

Parameters:
fxolFilename - - The name of the FOL table
tableFlag - - A flag to indicate the type of table created
storeMap - - A flag to indicate if values should be store in the Map
storeList - - A flag to indicate if values should be store in the Map
saveText - - A flag to indicate if text elements should be stored in the table

FOLTable

public FOLTable(java.lang.String fxolFilename,
                java.lang.String idxFilename,
                java.lang.String tableFlag,
                boolean storeMap,
                boolean storeList,
                boolean saveText)
Creates an FOLTable with the following parameters Min character length is 0

Parameters:
fxolFilename - - The name of the FOL table
idxFilename - - The name of the FOL table's index
tableFlag - - A flag to indicate the type of table created
storeMap - - A flag to indicate if values should be store in the Map
storeList - - A flag to indicate if values should be store in the Map
saveText - - A flag to indicate if text elements should be stored in the table

FOLTable

public FOLTable(java.lang.String fxolFilename,
                java.lang.String tableFlag,
                int minCharacterLength,
                boolean storeMap,
                boolean storeList,
                boolean saveText)
Creates an FOLTable with the following parameters No Index Filename (filename is empty string)

Parameters:
fxolFilename - - The name of the FOL table
tableFlag - - A flag to indicate the type of table created
minCharacterLength - - The minimum character length required for elements to be stored in the table
storeMap - - A flag to indicate if values should be store in the Map
storeList - - A flag to indicate if values should be store in the Map
saveText - - A flag to indicate if text elements should be stored in the table

FOLTable

public FOLTable(java.lang.String fxolFilename,
                java.lang.String idxFilename,
                java.lang.String tableFlag,
                int minCharacterLength,
                boolean storeMap,
                boolean storeList,
                boolean saveText)
Creates an FOLTable with the following parameters

Parameters:
fxolFilename - - The name of the FOL table
idxFilename - - The name of the FOL table's index
tableFlag - - A flag to indicate the type of table created
minCharacterLength - - The minimum character length required for elements to be stored in the table
storeMap - - A flag to indicate if values should be store in the Map
storeList - - A flag to indicate if values should be store in the Map
saveText - - A flag to indicate if text elements should be stored in the table
Method Detail

OpenTable

public void OpenTable()
Opens the tables


CloseTable

public void CloseTable()
Closes the tables


AddFile

public int AddFile(java.lang.String xmlfilename)
Adds a given xmlfile (and all its xpaths) to the table

Parameters:
xmlfilename -
Returns:
- The length of the file in bytes

ClearCollection

public void ClearCollection()
Clears the values in the collection


LoadIndex

public void LoadIndex(boolean storeMap,
                      boolean storeList)
Loads the values from the index into memory

Parameters:
storeMap -
storeList -

PopulateCollection

public void PopulateCollection(java.lang.String xmlfilename,
                               boolean storeMap,
                               boolean storeList)
This method loads the details of a particular document it assumes that index is loaded

Parameters:
xmlfilename -
storeMap -
storeList -

PrintIndex

public void PrintIndex()
Prints the index to the screen


PrintCollection

public void PrintCollection()
Prints the values in the table to the screen


GetListString

public java.lang.String GetListString()
Returns all the values in the table as a string

Returns:

ResortTable

public void ResortTable()
Sorts a table