|
|||||||||
| Home >> All >> org >> greenstone >> gatherer >> [ collection overview ] | PREV NEXT | ||||||||
A
- ARGUMENT - Static variable in class org.greenstone.gatherer.collection.BuildOptions
- The name of an argument element.
- ARGUMENT - Static variable in class org.greenstone.gatherer.collection.Collection
- The name of the argument element.
- actionPerformed(ActionEvent) - Method in class org.greenstone.gatherer.collection.DeleteCollectionPrompt.CloseButtonListener
- Any implementation of ActionListener must include this method so we can be informed when the button is actioned.
- actionPerformed(ActionEvent) - Method in class org.greenstone.gatherer.collection.DeleteCollectionPrompt.ConfirmationCheckBoxListener
- Any implementation of ActionListener must include this method so we can be informed when the button is actioned.
- actionPerformed(ActionEvent) - Method in class org.greenstone.gatherer.collection.DeleteCollectionPrompt.OKButtonListener
- Any implementation of ActionListener must include this method so we can be informed when the button is actioned.
- actionPerformed(ActionEvent) - Method in class org.greenstone.gatherer.collection.ExportCollectionPrompt.CancelButtonListener
- Any implementation of ActionListener must include this method so we can be informed when the button is actioned.
- actionPerformed(ActionEvent) - Method in class org.greenstone.gatherer.collection.ExportCollectionPrompt.OKButtonListener
- Any implementation of ActionListener must include this method so we can be informed when the button is actioned.
- actionPerformed(ActionEvent) - Method in class org.greenstone.gatherer.collection.ExportCollectionPrompt.ResultDialog.CloseButtonListener
- actionPerformed(ActionEvent) - Method in class org.greenstone.gatherer.collection.Job
- Depending on which button on the progress bar was pushed, this method will affect the state of the Job and perhaps make calls to wget.class if necessary.
- actionPerformed(ActionEvent) - Method in class org.greenstone.gatherer.collection.SaveCollectionBox
- Any implementation of ActionListener must include this method so that we can be informed when an action has occured.
- addDirectoryMapping(String, File) - Method in class org.greenstone.gatherer.collection.CollectionManager
- Add a special directory mapping.
- addDownload(String) - Method in class org.greenstone.gatherer.collection.Job
- Called by the WGet native code to inform us of a new download starting.
- addLink(String, int) - Method in class org.greenstone.gatherer.collection.Job
- Used to advise the Job of a newly parsed link.
- addSomeMetadataSets(File) - Method in class org.greenstone.gatherer.collection.CollectionManager
- I started giving the user the choice of using an existing meta set or creating a new one.
- all_collections - Variable in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- args - Variable in class org.greenstone.gatherer.collection.DeleteCollectionPrompt
- A string array used to pass arguments to the phrase retrieval method.
- args - Variable in class org.greenstone.gatherer.collection.ExportCollectionPrompt
B
- BASE_COLLECTION - Static variable in class org.greenstone.gatherer.collection.Collection
- BUILD - Static variable in class org.greenstone.gatherer.collection.Collection
- The name of the build element.
- BUILDING - Static variable in class org.greenstone.gatherer.collection.CollectionManager
- Used to indicate the source of the message is the building methods.
- BUILD_CONFIG - Static variable in class org.greenstone.gatherer.collection.Collection
- The name of the build config element.
- BasicCollectionConfiguration - class org.greenstone.gatherer.collection.BasicCollectionConfiguration.
- This class provides access to a collection configuration file.
- BasicCollectionConfiguration(File) - Constructor for class org.greenstone.gatherer.collection.BasicCollectionConfiguration
- BuildOptions - class org.greenstone.gatherer.collection.BuildOptions.
- Build options uses the argument list found in config.xml and the current settings from the loaded collection configuration to represent the options the user wants to use during import and build.
- BuildOptions(Element, Element) - Constructor for class org.greenstone.gatherer.collection.BuildOptions
- When constructing a BuildOptions object we first try to retrieve the valid arguments from config.xml.
- buildCollection() - Method in class org.greenstone.gatherer.collection.CollectionManager
- This method calls the builcol.pl scripts via a GShell so as to not lock up the processor.
- build_arguments_cache - Variable in class org.greenstone.gatherer.collection.BuildOptions
- A cache of previously created build arguments.
- build_arguments_element - Variable in class org.greenstone.gatherer.collection.BuildOptions
- The root element of the build argument tree.
- build_monitor - Variable in class org.greenstone.gatherer.collection.CollectionManager
- The monitor resposible for parsing the build process.
- build_options - Variable in class org.greenstone.gatherer.collection.Collection
- A reference to the BuildOptions.
- build_type - Variable in class org.greenstone.gatherer.collection.CollectionConfiguration
- build_values_element - Variable in class org.greenstone.gatherer.collection.BuildOptions
- The root element of the build values tree.
- building - Variable in class org.greenstone.gatherer.collection.CollectionManager
- Are we currently in the process of building?
- built() - Method in class org.greenstone.gatherer.collection.CollectionManager
- Used to determine whether the currently active collection has been built.
C
- CLOSE_COLLECTION - Static variable in class org.greenstone.gatherer.collection.SaveCollectionTask
- COLLECT - Static variable in class org.greenstone.gatherer.collection.CollectionManager
- Used to indicate the source of the message is the file collection methods.
- COLLECTION_CFG_SAVED - Static variable in class org.greenstone.gatherer.collection.SaveCollectionTask
- COLLECTION_COPIED - Static variable in class org.greenstone.gatherer.collection.SaveCollectionTask
- COLLECTION_SAVED - Static variable in class org.greenstone.gatherer.collection.SaveCollectionTask
- COLLECTION_XML_TEMPLATE - Static variable in class org.greenstone.gatherer.collection.Collection
- The name of the collection xml template.
- COMPLETE - Static variable in class org.greenstone.gatherer.collection.Job
- COPY_COLLECTION - Static variable in class org.greenstone.gatherer.collection.SaveCollectionTask
- Collection - class org.greenstone.gatherer.collection.Collection.
- Collection provides a common collection point for all the information about a certain collection build session.
- Collection(File) - Constructor for class org.greenstone.gatherer.collection.Collection
- Constructor.
- CollectionConfiguration - class org.greenstone.gatherer.collection.CollectionConfiguration.
- This class provides access to a collection configuration file.
- CollectionConfiguration(File) - Constructor for class org.greenstone.gatherer.collection.CollectionConfiguration
- CollectionManager - class org.greenstone.gatherer.collection.CollectionManager.
- This class manages many aspects of the collection, from its creation via scripts, data access via methods and its importing and building into the final collection.
- CollectionManager() - Constructor for class org.greenstone.gatherer.collection.CollectionManager
- Constructor.
- CollectionManager.FMTreeModelListener - class org.greenstone.gatherer.collection.CollectionManager.FMTreeModelListener.
- The CollectionManager class is getting too confusing by half so I'll implement this TreeModelListener in a private class to make responsibility clear.
- CollectionManager.FMTreeModelListener() - Constructor for class org.greenstone.gatherer.collection.CollectionManager.FMTreeModelListener
- callWGet() - Method in class org.greenstone.gatherer.collection.Job
- callWGetNative() - Method in class org.greenstone.gatherer.collection.Job
- The most important part of the Job class, this method is responsible for calling the WGet native methods used to mirror the indicated url.
- cancel - Variable in class org.greenstone.gatherer.collection.SaveCollectionBox
- Button to cancel prompt, no save.
- cancel_button - Variable in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- The close button, which exits the prompt without deleting anything.
- cd_title - Variable in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- cdm - Variable in class org.greenstone.gatherer.collection.Collection
- A reference to the Collection Design Manager.
- chooser - Variable in class org.greenstone.gatherer.collection.LoadCollectionBox
- clobber - Variable in class org.greenstone.gatherer.collection.Job
- closeCollection() - Method in class org.greenstone.gatherer.collection.CollectionManager
- Called to close the current collection and remove its lock file.
- close_after - Variable in class org.greenstone.gatherer.collection.SaveCollectionTask
- close_button - Variable in class org.greenstone.gatherer.collection.DeleteCollectionPrompt
- The close button, which exits the prompt without deleting anything.
- closing_thread - Variable in class org.greenstone.gatherer.collection.CollectionManager
- Holds a reference to the thread responsible for closing the collection.
- collection - Static variable in class org.greenstone.gatherer.collection.CollectionManager
- The collection this manager is managing!
- collection - Variable in class org.greenstone.gatherer.collection.DeleteCollectionPrompt
- The currently selected collection for deletion.
- collection - Variable in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- The currently selected collection for deletion.
- collection - Variable in class org.greenstone.gatherer.collection.SaveCollectionTask
- The current collection.
- collection_model - Variable in class org.greenstone.gatherer.collection.CollectionManager
- The collection_model.
- compareTo(Object) - Method in class org.greenstone.gatherer.collection.BasicCollectionConfiguration
- Compare this configuration to another for ordering, which essentially compares two strings for ordering.
- compareTo(Object) - Method in class org.greenstone.gatherer.collection.CollectionConfiguration
- configurationChanged() - Method in class org.greenstone.gatherer.collection.CollectionManager
- Method that is called whenever something has changed in the configuration of this collection.
- confirmation - Variable in class org.greenstone.gatherer.collection.DeleteCollectionPrompt
- The confirmation check box.
- copy(File, File) - Method in class org.greenstone.gatherer.collection.SaveCollectionTask
- copy_monitor - Variable in class org.greenstone.gatherer.collection.CollectionManager
- The monitor resposible for parsing the copy process.
- createCollection(String, String, String, String, File, ArrayList) - Method in class org.greenstone.gatherer.collection.CollectionManager
- Used to set the current collection to the given collection.
- createLockFile(File) - Method in class org.greenstone.gatherer.collection.CollectionManager
- creator - Variable in class org.greenstone.gatherer.collection.BasicCollectionConfiguration
- creator - Variable in class org.greenstone.gatherer.collection.CollectionConfiguration
- creator_element - Variable in class org.greenstone.gatherer.collection.BasicCollectionConfiguration
- creator_element - Variable in class org.greenstone.gatherer.collection.CollectionConfiguration
- current_coll_deleted - Variable in class org.greenstone.gatherer.collection.DeleteCollectionPrompt
- current_url - Variable in class org.greenstone.gatherer.collection.Job
D
- DeleteCollectionPrompt - class org.greenstone.gatherer.collection.DeleteCollectionPrompt.
- This class provides the functionality to delete current collections from the GSDLHOME/collect/ directory.
- DeleteCollectionPrompt() - Constructor for class org.greenstone.gatherer.collection.DeleteCollectionPrompt
- Constructor.
- DeleteCollectionPrompt.CloseButtonListener - class org.greenstone.gatherer.collection.DeleteCollectionPrompt.CloseButtonListener.
- A button listener implementation, which listens for actions on the close button and disposes of the dialog when detected.
- DeleteCollectionPrompt.CloseButtonListener() - Constructor for class org.greenstone.gatherer.collection.DeleteCollectionPrompt.CloseButtonListener
- DeleteCollectionPrompt.CollectionListListener - class org.greenstone.gatherer.collection.DeleteCollectionPrompt.CollectionListListener.
- This private class listens for selection events in from the list and then displays the appropriate details for that collection.
- DeleteCollectionPrompt.CollectionListListener() - Constructor for class org.greenstone.gatherer.collection.DeleteCollectionPrompt.CollectionListListener
- DeleteCollectionPrompt.ConfirmationCheckBoxListener - class org.greenstone.gatherer.collection.DeleteCollectionPrompt.ConfirmationCheckBoxListener.
- A check box listener so we can tell if the user has confirmed the deletion
- DeleteCollectionPrompt.ConfirmationCheckBoxListener() - Constructor for class org.greenstone.gatherer.collection.DeleteCollectionPrompt.ConfirmationCheckBoxListener
- DeleteCollectionPrompt.OKButtonListener - class org.greenstone.gatherer.collection.DeleteCollectionPrompt.OKButtonListener.
- The OK button listener implementation.
- DeleteCollectionPrompt.OKButtonListener() - Constructor for class org.greenstone.gatherer.collection.DeleteCollectionPrompt.OKButtonListener
- debug - Variable in class org.greenstone.gatherer.collection.Job
- depth - Variable in class org.greenstone.gatherer.collection.Job
- description - Variable in class org.greenstone.gatherer.collection.BasicCollectionConfiguration
- description - Variable in class org.greenstone.gatherer.collection.CollectionConfiguration
- description_element - Variable in class org.greenstone.gatherer.collection.BasicCollectionConfiguration
- description_element - Variable in class org.greenstone.gatherer.collection.CollectionConfiguration
- destination - Variable in class org.greenstone.gatherer.collection.Job
- destroy() - Method in class org.greenstone.gatherer.collection.Collection
- Destructor.
- destroy() - Method in class org.greenstone.gatherer.collection.DeleteCollectionPrompt
- Destructor.
- destroy() - Method in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- Destructor.
- destroy() - Method in class org.greenstone.gatherer.collection.SaveCollectionBox
- Destructor.
- details - Variable in class org.greenstone.gatherer.collection.DeleteCollectionPrompt
- The text area used to display details about the collection selected.
- details_label - Variable in class org.greenstone.gatherer.collection.DeleteCollectionPrompt
- The label above details.
- details_label - Variable in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- The label above details.
- details_textarea - Variable in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- The text area used to display details about the collection selected.
- display() - Method in class org.greenstone.gatherer.collection.DeleteCollectionPrompt
- This method causes the modal prompt to be displayed.
- display() - Method in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- This method causes the modal prompt to be displayed.
- document - Variable in class org.greenstone.gatherer.collection.Collection
- The document around which this collection class is based.
- downloadComplete() - Method in class org.greenstone.gatherer.collection.Job
- Called by the WGet native code when the current download is completed.
- downloadFailed() - Method in class org.greenstone.gatherer.collection.Job
- Called by the WGet native code when the requested download returns a status code other than 200.
- downloadWarning() - Method in class org.greenstone.gatherer.collection.Job
E
- ENABLED - Static variable in class org.greenstone.gatherer.collection.BuildOptions
- The name of the enabled attribute.
- ExportCollectionPrompt - class org.greenstone.gatherer.collection.ExportCollectionPrompt.
- This class provides the functionality to export current collections from the GSDLHOME/collect/ directory to CDROM.
- ExportCollectionPrompt() - Constructor for class org.greenstone.gatherer.collection.ExportCollectionPrompt
- Constructor.
- ExportCollectionPrompt.CancelButtonListener - class org.greenstone.gatherer.collection.ExportCollectionPrompt.CancelButtonListener.
- A button listener implementation, which listens for actions on the close button and disposes of the dialog when detected.
- ExportCollectionPrompt.CancelButtonListener() - Constructor for class org.greenstone.gatherer.collection.ExportCollectionPrompt.CancelButtonListener
- ExportCollectionPrompt.CollectionListListener - class org.greenstone.gatherer.collection.ExportCollectionPrompt.CollectionListListener.
- This private class listens for selection events in from the list and then displays the appropriate details for that collection.
- ExportCollectionPrompt.CollectionListListener() - Constructor for class org.greenstone.gatherer.collection.ExportCollectionPrompt.CollectionListListener
- ExportCollectionPrompt.OKButtonListener - class org.greenstone.gatherer.collection.ExportCollectionPrompt.OKButtonListener.
- The OK button listener implementation.
- ExportCollectionPrompt.OKButtonListener() - Constructor for class org.greenstone.gatherer.collection.ExportCollectionPrompt.OKButtonListener
- ExportCollectionPrompt.OKButtonListener.ProgressDialog - class org.greenstone.gatherer.collection.ExportCollectionPrompt.OKButtonListener.ProgressDialog.
- ExportCollectionPrompt.OKButtonListener.ProgressDialog() - Constructor for class org.greenstone.gatherer.collection.ExportCollectionPrompt.OKButtonListener.ProgressDialog
- ExportCollectionPrompt.ResultDialog - class org.greenstone.gatherer.collection.ExportCollectionPrompt.ResultDialog.
- ExportCollectionPrompt.ResultDialog(boolean, String) - Constructor for class org.greenstone.gatherer.collection.ExportCollectionPrompt.ResultDialog
- ExportCollectionPrompt.ResultDialog.CloseButtonListener - class org.greenstone.gatherer.collection.ExportCollectionPrompt.ResultDialog.CloseButtonListener.
- ExportCollectionPrompt.ResultDialog.CloseButtonListener() - Constructor for class org.greenstone.gatherer.collection.ExportCollectionPrompt.ResultDialog.CloseButtonListener
- elementChanged(MSMEvent) - Method in class org.greenstone.gatherer.collection.CollectionManager
- Method that is called whenever an element within a set is changed or modified.
- encountered_urls - Variable in class org.greenstone.gatherer.collection.Job
- equals(Object) - Method in class org.greenstone.gatherer.collection.BasicCollectionConfiguration
- equals(Object) - Method in class org.greenstone.gatherer.collection.CollectionConfiguration
- error_message - Variable in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- the error message if any
- exit_after - Variable in class org.greenstone.gatherer.collection.SaveCollectionTask
- Should we exit the Gatherer once this save is complete.
- exportCollections() - Method in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- This method calls the builcol.pl scripts via a GShell so as to not lock up the processor.
- exporting - Variable in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- whether we are trying to export or not
F
- FALSE - Static variable in class org.greenstone.gatherer.collection.BuildOptions
- The name of the 'false' value.
- failed_urls - Variable in class org.greenstone.gatherer.collection.Job
- file - Variable in class org.greenstone.gatherer.collection.BasicCollectionConfiguration
- file - Variable in class org.greenstone.gatherer.collection.Collection
- The file the collection is in (the file may not actually exist, such in the case of a legacy collection)!
- file - Variable in class org.greenstone.gatherer.collection.CollectionConfiguration
- fm_tree_model_listener - Variable in class org.greenstone.gatherer.collection.CollectionManager
- An inner class listener responsible for noting tree changes and resetting saved when they occur.
G
- gdm - Variable in class org.greenstone.gatherer.collection.Collection
- A reference to the Greenstone Directory Metadata Manager.
- get(String) - Method in class org.greenstone.gatherer.collection.Collection
- Get the value of a collection argument.
- getArgument(Element, int) - Method in class org.greenstone.gatherer.collection.BuildOptions
- Retrieve the indexth element from the given set of arguments.
- getArguments(boolean) - Method in class org.greenstone.gatherer.collection.BuildOptions
- Retrieve the arguments associated with a certain type of action, ie import or build.
- getBaseCollection() - Method in class org.greenstone.gatherer.collection.Collection
- Determine the path to the base collection.
- getBuildArgument(int) - Method in class org.greenstone.gatherer.collection.BuildOptions
- Retrieve the indexth argument belonging to build.
- getBuildArgumentCount() - Method in class org.greenstone.gatherer.collection.BuildOptions
- Retrieve the number of arguments involved in building.
- getBuildType() - Method in class org.greenstone.gatherer.collection.CollectionConfiguration
- getBuildValue(String) - Method in class org.greenstone.gatherer.collection.BuildOptions
- Retrieve the value of a certain build argument.
- getBuildValueEnabled(String) - Method in class org.greenstone.gatherer.collection.BuildOptions
- Determine if the named argument value is enabled or disabled.
- getBuildValues() - Method in class org.greenstone.gatherer.collection.BuildOptions
- Retrieve all of the build values as a String array ready to added to the buildcol.pl call.
- getBuildValues() - Method in class org.greenstone.gatherer.collection.Collection
- Method to retrieve the current build options associated with this Collection.
- getCollection() - Method in class org.greenstone.gatherer.collection.CollectionManager
- Retrieve the current collection.
- getCollectionArchive() - Method in class org.greenstone.gatherer.collection.CollectionManager
- Constructs the absolute filename of the collection archive directory, which should resemble "$GSDLHOME/collect/<col_name>/archive/"
- getCollectionBuild() - Method in class org.greenstone.gatherer.collection.CollectionManager
- Constructs the absolute filename of the collection building directory, which should resemble "$GSDLHOME/collect/<col_name>/building/"
- getCollectionCache() - Method in class org.greenstone.gatherer.collection.CollectionManager
- Constructs the absolute filename of the collection cache directory, which should resemble "$GSDLHOME/collect/<col_name>/gcache/"
- getCollectionConfig() - Method in class org.greenstone.gatherer.collection.CollectionManager
- Constructs the absolute filename of the collection config file, which should resemble "$GSDLHOME/collect/<col_name>/etc/collect.cfg"
- getCollectionDirectory() - Method in class org.greenstone.gatherer.collection.CollectionManager
- Constructs the absolute filename of the collection directory, which should resemble "$GSDLHOME/collect/<col_name>"
- getCollectionEtc() - Method in class org.greenstone.gatherer.collection.CollectionManager
- Constructs the absolute filename of the collection etc directory, which should resemble "$GSDLHOME/collect/<col_name>/etc/"
- getCollectionFilename() - Method in class org.greenstone.gatherer.collection.CollectionManager
- Constructs the absolute filename of the collection file, which should resemble "$GSDLHOME/collect/<col_name>/<col_name>.col"
- getCollectionImages() - Method in class org.greenstone.gatherer.collection.CollectionManager
- Constructs the absolute filename of the collection images directory, which should resemble "$GSDLHOME/collect/<col_name>/images/"
- getCollectionImport() - Method in class org.greenstone.gatherer.collection.CollectionManager
- Constructs the absolute filename of the collection import directory, which should resemble "$GSDLHOME/collect/<col_name>/import/"
- getCollectionIndex() - Method in class org.greenstone.gatherer.collection.CollectionManager
- Constructs the absolute filename of the collection index directory, which should resemble "$GSDLHOME/collect/<col_name>/index/"
- getCollectionLog() - Method in class org.greenstone.gatherer.collection.CollectionManager
- Constructs the absolute filename of the collection log directory, which should resemble "$GSDLHOME/collect/<col_name>/log/"
- getCollectionMetadata() - Method in class org.greenstone.gatherer.collection.CollectionManager
- Constructs the absolute filename of the collection metadata directory, which should resemble "$GSDLHOME/collect/<col_name>/metadata/"
- getCollectionSpecificMappings() - Static method in class org.greenstone.gatherer.collection.CollectionManager
- getCount() - Method in class org.greenstone.gatherer.collection.Collection
- Determine the number of documents and folders in this collection.
- getCount(TreeNode, boolean, boolean) - Method in class org.greenstone.gatherer.collection.Collection
- Count either documents or folders, depending on the state of the given boolean.
- getCreator() - Method in class org.greenstone.gatherer.collection.BasicCollectionConfiguration
- Retrieve the creators email for this collection.
- getCreator() - Method in class org.greenstone.gatherer.collection.CollectionConfiguration
- getDescription() - Method in class org.greenstone.gatherer.collection.BasicCollectionConfiguration
- getDescription() - Method in class org.greenstone.gatherer.collection.Collection
- Retrieve the description of this collection.
- getDescription() - Method in class org.greenstone.gatherer.collection.CollectionConfiguration
- getDocumentCount() - Method in class org.greenstone.gatherer.collection.Collection
- Calculates the number of documents in this collection.
- getEmail() - Method in class org.greenstone.gatherer.collection.Collection
- Retrieve the authors email for this collection.
- getFile() - Method in class org.greenstone.gatherer.collection.BasicCollectionConfiguration
- getFile() - Method in class org.greenstone.gatherer.collection.CollectionConfiguration
- getFileName() - Method in class org.greenstone.gatherer.collection.LoadCollectionBox
- getGreenstoneCollectionsMapping() - Static method in class org.greenstone.gatherer.collection.CollectionManager
- getHost() - Method in class org.greenstone.gatherer.collection.Job
- getImportArgument(int) - Method in class org.greenstone.gatherer.collection.BuildOptions
- Retrieve the indexth argument belonging to import.
- getImportArgumentCount() - Method in class org.greenstone.gatherer.collection.BuildOptions
- Retrieve the number of arguments involved in importing.
- getImportValue(String) - Method in class org.greenstone.gatherer.collection.BuildOptions
- Retrieve the value of a certain build argument.
- getImportValueEnabled(String) - Method in class org.greenstone.gatherer.collection.BuildOptions
- Determine if the named argument value is enabled or disabled.
- getImportValues() - Method in class org.greenstone.gatherer.collection.BuildOptions
- Retrieve all of the import arguments in a form ready to be sent out to a shell process.
- getImportValues() - Method in class org.greenstone.gatherer.collection.Collection
- Method to retrieve the current import options associated with this Collection.
- getMaintainer() - Method in class org.greenstone.gatherer.collection.BasicCollectionConfiguration
- getMaintainer() - Method in class org.greenstone.gatherer.collection.CollectionConfiguration
- getName() - Method in class org.greenstone.gatherer.collection.BasicCollectionConfiguration
- getName() - Method in class org.greenstone.gatherer.collection.Collection
- Retrieve the short name for this collection.
- getName() - Method in class org.greenstone.gatherer.collection.CollectionConfiguration
- getProgressBar() - Method in class org.greenstone.gatherer.collection.Job
- getRecordSet() - Method in class org.greenstone.gatherer.collection.CollectionManager
- Retrieve the record set (tree model) associated with the current collection.
- getSaved() - Method in class org.greenstone.gatherer.collection.Collection
- Determine if this collection has been saved since the last major change.
- getSearchTypes() - Method in class org.greenstone.gatherer.collection.CollectionConfiguration
- getShortName() - Method in class org.greenstone.gatherer.collection.BasicCollectionConfiguration
- Retrieve the short name for this collection which, given this current file is in
/etc/collect.cfg, is the name of this file's parent file's parent. - getShortName() - Method in class org.greenstone.gatherer.collection.CollectionConfiguration
- Retrieve the short name for this collection which, given this current file is in
/etc/collect.cfg, is the name of this file's parent file's parent. - getState() - Method in class org.greenstone.gatherer.collection.Job
- Called to discover if the user wanted this thread to run or if it is paused.
- getString(String) - Method in class org.greenstone.gatherer.collection.Collection
- Get the value of a collection argument.
- getTitle() - Method in class org.greenstone.gatherer.collection.Collection
- Retrieve the title of this collection.
- getUserOption(String) - Method in class org.greenstone.gatherer.collection.SaveCollectionBox
- Displays the prompt by first building the controls, then waits for a user selection.
- getValue(Element, String, boolean) - Method in class org.greenstone.gatherer.collection.BuildOptions
- getValue(int) - Method in class org.greenstone.gatherer.collection.SaveCollectionTask
- getValues(Element) - Method in class org.greenstone.gatherer.collection.BuildOptions
- glass_pane - Variable in class org.greenstone.gatherer.collection.ExportCollectionPrompt.OKButtonListener
H
- hasSignalledStop() - Method in class org.greenstone.gatherer.collection.Job
- Returns the current state of the stop flag for this job.
- higher_directories - Variable in class org.greenstone.gatherer.collection.Job
I
- IMPORT - Static variable in class org.greenstone.gatherer.collection.Collection
- The name of the import element.
- IMPORTED - Static variable in class org.greenstone.gatherer.collection.Collection
- The name of the imported attribute.
- importCollection() - Method in class org.greenstone.gatherer.collection.CollectionManager
- This method when called, creates a new GShell in order to run the import.pl script.
- import_after - Variable in class org.greenstone.gatherer.collection.SaveCollectionTask
- Do we run the import scripts once this save is complete.
- import_arguments_cache - Variable in class org.greenstone.gatherer.collection.BuildOptions
- A cache of previously created import arguments.
- import_arguments_element - Variable in class org.greenstone.gatherer.collection.BuildOptions
- The root element of the import argument tree.
- import_monitor - Variable in class org.greenstone.gatherer.collection.CollectionManager
- The monitor resposible for parsing the import process.
- import_values_element - Variable in class org.greenstone.gatherer.collection.BuildOptions
- The root element of the import values tree.
- importing - Variable in class org.greenstone.gatherer.collection.CollectionManager
- Are we currently in the process of importing?
- initial - Variable in class org.greenstone.gatherer.collection.Job
- installCollection() - Method in class org.greenstone.gatherer.collection.CollectionManager
- Install collection by moving its files from building to index after a successful build.
- instructions_textarea - Variable in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- The text area used to display instructions for the export
J
- Job - class org.greenstone.gatherer.collection.Job.
- Job(boolean, boolean, boolean, boolean, boolean, boolean, URL, int, String, String, String, WGet, boolean) - Constructor for class org.greenstone.gatherer.collection.Job
K
- keyReleased(KeyEvent) - Method in class org.greenstone.gatherer.collection.SaveCollectionBox.KeyListenerImpl
- Any extension of KeyAdapter can override this method so that we can be informed whenever a key is released (ie after a keyTyped event).
L
- LOCK_FILE - Static variable in class org.greenstone.gatherer.collection.CollectionManager
- The name of the standard lock file.
- LoadCollectionBox - class org.greenstone.gatherer.collection.LoadCollectionBox.
- LoadCollectionBox() - Constructor for class org.greenstone.gatherer.collection.LoadCollectionBox
- list - Variable in class org.greenstone.gatherer.collection.DeleteCollectionPrompt
- The list of available collections.
- list - Variable in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- The list of collections to export
- list_label - Variable in class org.greenstone.gatherer.collection.DeleteCollectionPrompt
- The label above the list.
- list_label - Variable in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- The label above the list.
- list_model - Variable in class org.greenstone.gatherer.collection.DeleteCollectionPrompt
- The model behind the list.
- list_model - Variable in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- The model behind the list.
- loadArguments(String) - Method in class org.greenstone.gatherer.collection.BuildOptions
- loadCollection(String) - Method in class org.greenstone.gatherer.collection.CollectionManager
- Attempts to load the given collection.
M
- MAKE_COLLECTION - Static variable in class org.greenstone.gatherer.collection.SaveCollectionTask
- METADATA_SAVED - Static variable in class org.greenstone.gatherer.collection.SaveCollectionTask
- METADATA_XML_SAVED - Static variable in class org.greenstone.gatherer.collection.SaveCollectionTask
- maintainer - Variable in class org.greenstone.gatherer.collection.BasicCollectionConfiguration
- maintainer - Variable in class org.greenstone.gatherer.collection.CollectionConfiguration
- maintainer_element - Variable in class org.greenstone.gatherer.collection.BasicCollectionConfiguration
- maintainer_element - Variable in class org.greenstone.gatherer.collection.CollectionConfiguration
- makeCollection(String, String, String, String) - Method in class org.greenstone.gatherer.collection.CollectionManager
- message(GShellEvent) - Method in class org.greenstone.gatherer.collection.CollectionManager
- Any implementation of GShellListener must include this method to allow the GShell to send messages to listeners.
- message(GShellEvent) - Method in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- All implementation of GShellListener must include this method so the listener can be informed of messages from the GShell.
- metadataChanged(MSMEvent) - Method in class org.greenstone.gatherer.collection.CollectionManager
- Called whenever the metadata value changes in some way, such as the addition of a new value.
- mouse_blocker_listener - Variable in class org.greenstone.gatherer.collection.ExportCollectionPrompt.OKButtonListener
- msm - Variable in class org.greenstone.gatherer.collection.Collection
- A reference to the Metadata Set Manager.
- msm - Variable in class org.greenstone.gatherer.collection.CollectionManager
- A reference to the metadata set manager.
- mummy - Variable in class org.greenstone.gatherer.collection.Job
- myself - Variable in class org.greenstone.gatherer.collection.SaveCollectionBox
- A reference to ourselves so our inner classes can dispose of us.
N
- NAME - Static variable in class org.greenstone.gatherer.collection.BuildOptions
- The name of a name attribute.
- NO_SPECIAL_CASE - Static variable in class org.greenstone.gatherer.collection.CollectionManager
- name - Variable in class org.greenstone.gatherer.collection.BasicCollectionConfiguration
- name - Variable in class org.greenstone.gatherer.collection.CollectionConfiguration
- name - Variable in class org.greenstone.gatherer.collection.SaveCollectionTask
- The filename of the collection we are saving.
- name_element - Variable in class org.greenstone.gatherer.collection.BasicCollectionConfiguration
- name_element - Variable in class org.greenstone.gatherer.collection.CollectionConfiguration
- no - Variable in class org.greenstone.gatherer.collection.SaveCollectionBox
- Button for no save.
- no_parents - Variable in class org.greenstone.gatherer.collection.Job
O
- OPEN_COLLECTION - Static variable in class org.greenstone.gatherer.collection.SaveCollectionTask
- OPTION - Static variable in class org.greenstone.gatherer.collection.BuildOptions
- The name of an option element.
- ok_button - Variable in class org.greenstone.gatherer.collection.DeleteCollectionPrompt
- The ok button which causes the selected collection to be deleted.
- ok_button - Variable in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- The ok button which causes the selected collection to be deleted.
- ok_button_listener - Variable in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- org.greenstone.gatherer.collection - package org.greenstone.gatherer.collection
- other_hosts - Variable in class org.greenstone.gatherer.collection.Job
P
- PAUSED - Static variable in class org.greenstone.gatherer.collection.Job
- page_requisites - Variable in class org.greenstone.gatherer.collection.Job
- previous_state - Variable in class org.greenstone.gatherer.collection.Job
- processBegun(GShellEvent) - Method in class org.greenstone.gatherer.collection.CollectionManager
- This call is fired whenever a process within a GShell created by this class begins.
- processBegun(GShellEvent) - Method in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- All implementation of GShellListener must include this method so the listener can be informed when a GShell begins its task.
- processComplete(GShellEvent) - Method in class org.greenstone.gatherer.collection.CollectionManager
- This call is fired whenever a process within a GShell created by this class ends.
- processComplete() - Method in class org.greenstone.gatherer.collection.ExportCollectionPrompt.OKButtonListener
- processComplete(GShellEvent) - Method in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- All implementation of GShellListener must include this method so the listener can be informed when a GShell completes its task.
- progress - Variable in class org.greenstone.gatherer.collection.Job
- progress_dialog - Variable in class org.greenstone.gatherer.collection.ExportCollectionPrompt.OKButtonListener
- prompt - Variable in class org.greenstone.gatherer.collection.DeleteCollectionPrompt
- A reference to ourself so any inner-classes can dispose of us.
- prompt - Variable in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- A reference to ourself so any inner-classes can dispose of us.
- proxy_pass - Variable in class org.greenstone.gatherer.collection.Job
- proxy_user - Variable in class org.greenstone.gatherer.collection.Job
Q
R
- RESTORE_COLLECTION - Static variable in class org.greenstone.gatherer.collection.SaveCollectionTask
- RUNNING - Static variable in class org.greenstone.gatherer.collection.Job
- ready() - Static method in class org.greenstone.gatherer.collection.CollectionManager
- Determine if the manager is ready for actions apon its collection.
- reallyReady() - Method in class org.greenstone.gatherer.collection.CollectionManager
- registerBuildMonitor(GShellProgressMonitor) - Method in class org.greenstone.gatherer.collection.CollectionManager
- This method associates the collection build monitor with the build monitor created in CreatePane.
- registerCopyMonitor(GShellProgressMonitor) - Method in class org.greenstone.gatherer.collection.CollectionManager
- This method associates the collection copy monitor with the copy monitor created in CreatePane.
- registerImportMonitor(GShellProgressMonitor) - Method in class org.greenstone.gatherer.collection.CollectionManager
- This method associates the collection import monitor with the import monitor created in CreatePane.
- removeBuildValue(String) - Method in class org.greenstone.gatherer.collection.BuildOptions
- Remove the given build value.
- removeDirectoryMapping(FileNode) - Method in class org.greenstone.gatherer.collection.CollectionManager
- Remove a previously assigned special directory mapping.
- removeImportValue(String) - Method in class org.greenstone.gatherer.collection.BuildOptions
- Remove the given import value.
- removeValue(Element, String) - Method in class org.greenstone.gatherer.collection.BuildOptions
- Remove the named value from the given arguments element.
- result - Variable in class org.greenstone.gatherer.collection.SaveCollectionBox
- What option the user has choosen.
- resultPrompt(boolean) - Method in class org.greenstone.gatherer.collection.DeleteCollectionPrompt
- Shows a delete complete prompt.
- resultPrompt(boolean, String) - Method in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- Shows an export complete prompt.
- run() - Method in class org.greenstone.gatherer.collection.SaveCollectionTask
- This method, when created in a forked process by start(), performs the actions necessary to save a collection.
S
- SAVE_CANCEL - Static variable in class org.greenstone.gatherer.collection.SaveCollectionBox
- Result value if the user has choosen cancel.
- SAVE_NO - Static variable in class org.greenstone.gatherer.collection.SaveCollectionBox
- Result value if the user has choosen no.
- SAVE_YES - Static variable in class org.greenstone.gatherer.collection.SaveCollectionBox
- Result value if the user has choosen yes.
- SIZE - Static variable in class org.greenstone.gatherer.collection.DeleteCollectionPrompt
- The size of the delete prompt screen.
- SIZE - Static variable in class org.greenstone.gatherer.collection.ExportCollectionPrompt
- The size of the export prompt screen.
- SPECIAL_DLS - Static variable in class org.greenstone.gatherer.collection.CollectionManager
- STOPPED - Static variable in class org.greenstone.gatherer.collection.Job
- SaveCollectionBox - class org.greenstone.gatherer.collection.SaveCollectionBox.
- Provides a prompt allowing the user some choice in whether a collection saves.
- SaveCollectionBox() - Constructor for class org.greenstone.gatherer.collection.SaveCollectionBox
- Construtor.
- SaveCollectionBox.KeyListenerImpl - class org.greenstone.gatherer.collection.SaveCollectionBox.KeyListenerImpl.
- Listens for key presses when the focus is on one of the buttons.
- SaveCollectionBox.KeyListenerImpl() - Constructor for class org.greenstone.gatherer.collection.SaveCollectionBox.KeyListenerImpl
- SaveCollectionTask - class org.greenstone.gatherer.collection.SaveCollectionTask.
- The actually saving of a collection must run in a thread other than the AWTEvent thread, or else the save progress box will never get updated.
- SaveCollectionTask(Collection) - Constructor for class org.greenstone.gatherer.collection.SaveCollectionTask
- Constructor.
- SaveCollectionTask(Collection, boolean, boolean) - Constructor for class org.greenstone.gatherer.collection.SaveCollectionTask
- Constructor.
- SaveCollectionTask(Collection, String) - Constructor for class org.greenstone.gatherer.collection.SaveCollectionTask
- Constructor.
- save() - Method in class org.greenstone.gatherer.collection.Collection
- Save this xml document to the given file.
- saveCollection(boolean, boolean) - Method in class org.greenstone.gatherer.collection.CollectionManager
- Saves a collection by serializing it to file.
- saveCollectionAs(String) - Method in class org.greenstone.gatherer.collection.CollectionManager
- Saves the current collection to a new filename, then restores the original collection.
- saved - Variable in class org.greenstone.gatherer.collection.Collection
- true if the currently loaded collection has been saved since the last significant change, false otherwise.
- saved() - Method in class org.greenstone.gatherer.collection.CollectionManager
- Used to check whether all open collections have a 'saved' state.
- scanForCollections() - Method in class org.greenstone.gatherer.collection.