|
|||||||||
| Home >> All >> org >> greenstone >> gatherer >> [ msm overview ] | PREV NEXT | ||||||||
A
- ACCUMULATE - Static variable in class org.greenstone.gatherer.msm.GDMDocument
- ADD - Static variable in class org.greenstone.gatherer.msm.Declarations
- An element of the action type enumeration.
- ALIASES - Static variable in class org.greenstone.gatherer.msm.MSMUtils
- An element of the enumeration of type filter.
- ALL_METADATA_TYPES - Static variable in class org.greenstone.gatherer.msm.GDMDocument
- ALL_VALUES - Static variable in class org.greenstone.gatherer.msm.MetadataSet
- An element of the tree pruning filter enumeration, that indicates all nodes in the tree should be retained.
- accept(File) - Method in class org.greenstone.gatherer.msm.MDSFileFilter
- Override this method to return true only if the file extension is .mds.
- accept(File, String) - Method in class org.greenstone.gatherer.msm.MetadataSetManager.MDVFilenameFilter
- accumulate - Variable in class org.greenstone.gatherer.msm.Metadata
- Is this an accumulating piece of metadata?
- accumulates() - Method in class org.greenstone.gatherer.msm.Metadata
- Determine if this metadata overwrites or accumulates.
- action - Variable in class org.greenstone.gatherer.msm.ExportMDSPrompt
- The action the user has chosen from the dialog (either -1, if cancelled, or EXPORT).
- action - Variable in class org.greenstone.gatherer.msm.MSMAction
- The type of action required in subsequent actions involving the specified set and source element.
- action - Variable in class org.greenstone.gatherer.msm.MSMEvent
- The action initiated by the user which caused this event, if any
- action - Variable in class org.greenstone.gatherer.msm.MSMPrompt
- actionPerformed(ActionEvent) - Method in class org.greenstone.gatherer.msm.ExportMDSPrompt
- Whenever one of the buttons in the dialog is actioned this method is called to trigger the appropriate effects.
- actionPerformed(ActionEvent) - Method in class org.greenstone.gatherer.msm.MSMPrompt.AddListener
- actionPerformed(ActionEvent) - Method in class org.greenstone.gatherer.msm.MSMPrompt.CancelListener
- actionPerformed(ActionEvent) - Method in class org.greenstone.gatherer.msm.MSMPrompt.IgnoreListener
- actionPerformed(ActionEvent) - Method in class org.greenstone.gatherer.msm.MSMPrompt.MergeListener
- actionPerformed(ElementWrapper) - Method in class org.greenstone.gatherer.msm.MSMPrompt.SetListener
- because the dialog constructor is selecting an element before calling actionPerformed, and actionPerformed is where the list of elements is built, we need to tell this what element should be selected
- actionPerformed(ActionEvent) - Method in class org.greenstone.gatherer.msm.MSMPrompt.SetListener
- actionPerformed(ActionEvent) - Method in class org.greenstone.gatherer.msm.MSMPrompt
- Any implementation of ActionListener must include this method so that we can be informed when an action has occured.
- add - Variable in class org.greenstone.gatherer.msm.MSMPrompt
- add(Node, Node) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- Method to add one node as a child of another, after migrating into the target document.
- addAction(String, String, String) - Method in class org.greenstone.gatherer.msm.MSMProfiler
- Adds a new action mapping to the profile.
- addAttribute(String, String) - Method in class org.greenstone.gatherer.msm.ElementWrapper
- addAttribute(String, String, String) - Method in class org.greenstone.gatherer.msm.ElementWrapper
- addAttribute(String, String) - Method in class org.greenstone.gatherer.msm.MetadataSet
- Add a mds level attribute.
- addElement(String, String) - Method in class org.greenstone.gatherer.msm.MetadataSet
- Add a new default metadata element with the given name to this metadata set.
- addElement(Element, GValueModel) - Method in class org.greenstone.gatherer.msm.MetadataSet
- Method to add a new metadata element to this metadata set, if and only if the element is not already present.
- addElement(Element, String, GValueModel) - Method in class org.greenstone.gatherer.msm.MetadataSet
- Method to add a new metadata element with the specified new name to this metadata set, if and only if the name is not already in use.
- addElementAttribute(Node, String, String, String) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- addFailed(Element, String) - Method in class org.greenstone.gatherer.msm.MSMPrompt
- When called this method produces a nice error message on the screen, advising the user that the add action has failed.
- addMSMListener(MSMListener) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Adds a metadata set listener to this set, if it isn't alreay listening.
- addMetadata(String, Metadata, boolean) - Method in class org.greenstone.gatherer.msm.GDMDocument
- Add this metadata to the named file.
- addMetadata(FileNode, ArrayList) - Method in class org.greenstone.gatherer.msm.GDMManager
- This may seem a little odd but this method doesn't add the given metadata directly, instead calling fireMetadataChanged in MetadataSetManager so as to recursively add metadata if necessary, and to ensure that all listeners who are interested in data change (such as the Metadata Table and Save listeners) can be up to date.
- addMetadata(long, FileNode[], ElementWrapper, String) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Attach a piece of metadata to a record or records, ensuring the value tree is built properly, and correct messaging fired.
- addMetadata(long, FileNode[], ElementWrapper, String, int) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- addMetadata(long, FileNode, Metadata, int, boolean) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Add a reference to a piece of metadata to the given FileNode.
- addSet(String, String) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- addSource(String) - Method in class org.greenstone.gatherer.msm.MSMProfiler
- addValueTree(ElementWrapper, GValueModel) - Method in class org.greenstone.gatherer.msm.MetadataSet
- Add a value tree to a given metadata element.
- addValueTree(GValueModel) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Add a value tree to a given metadata element.
- add_button - Variable in class org.greenstone.gatherer.msm.MSMPrompt.SetListener
- alias - Variable in class org.greenstone.gatherer.msm.LegacyCollectionImporter.HFile.Entry
- all_values - Variable in class org.greenstone.gatherer.msm.ExportMDSPrompt
- Ths button that, if selected, signifies you wish to export the metadata set with all values.
- assignedValuesEqual(Node, Node) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- A method for comparing two AssignedValues trees.
- attributesEqual(Node, Node) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- A method for comparing two attribute nodes of type Node not Attr as you might think.
B
- BOTH - Static variable in class org.greenstone.gatherer.msm.MSMUtils
- An element of the enumeration of type filter.
- base_document - Variable in class org.greenstone.gatherer.msm.GDMDocument
- The document this class sources its data from.
- browse_button - Variable in class org.greenstone.gatherer.msm.ExportMDSPrompt
- The button used to browse the local file system.
C
- CANCEL - Static variable in class org.greenstone.gatherer.msm.Declarations
- An element of the action type enumeration.
- cancel - Variable in class org.greenstone.gatherer.msm.MSMPrompt
- cancel_button - Variable in class org.greenstone.gatherer.msm.ExportMDSPrompt
- Used to cancel the dialog.
- cdm - Variable in class org.greenstone.gatherer.msm.LegacyCollectionImporter
- checkCache(Metadata) - Method in class org.greenstone.gatherer.msm.GDMManager
- checkForHierarchy(ElementWrapper, Element) - Method in class org.greenstone.gatherer.msm.LegacyCollectionImporter
- clear(Node) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- Remove all of the child nodes from a certain node.
- collection_folder - Variable in class org.greenstone.gatherer.msm.LegacyCollectionImporter
- compare(Object, Object) - Method in class org.greenstone.gatherer.msm.MSMUtils.MetadataComparator
- Compares its two arguments for order.
- compare(Element, Element) - Method in class org.greenstone.gatherer.msm.MetadataSet
- compareTo(Object) - Method in class org.greenstone.gatherer.msm.ElementWrapper
- Compare two element wrappers for ordering.
- compareTo(Object) - Method in class org.greenstone.gatherer.msm.Metadata
- Compares two Metadata objects for ordering purposes.
- containsAction(String, String) - Method in class org.greenstone.gatherer.msm.MSMProfiler
- Determine if an action exists for the given collection and source.
- containsElement(String) - Method in class org.greenstone.gatherer.msm.MetadataSet
- A method to determine if this metadata set contains an element with a certain name (case sensitive).
- containsSource(String) - Method in class org.greenstone.gatherer.msm.MSMProfiler
- copy() - Method in class org.greenstone.gatherer.msm.ElementWrapper
- Create a copy of this element wrapper.
- count - Static variable in class org.greenstone.gatherer.msm.MSMEvent
- The message counter.
- count - Variable in class org.greenstone.gatherer.msm.Metadata
- Used to count the number of references to this piece of metadata within the metadata table.
- countMetadata() - Method in class org.greenstone.gatherer.msm.GDMDocument
- createHidden() - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Create the hidden mds, used for custom classifiers.
D
- DELETE - Static variable in class org.greenstone.gatherer.msm.Declarations
- An element of the action type enumeration.
- DESCRIPTION_ELEMENT - Static variable in class org.greenstone.gatherer.msm.GDMDocument
- DIRECTORY_FILENAME - Static variable in class org.greenstone.gatherer.msm.GDMDocument
- The pattern to match when searching for directory level assignments.
- Declarations - class org.greenstone.gatherer.msm.Declarations.
- This utility class contains several enumerations used throughout the MSM package.
- Declarations() - Constructor for class org.greenstone.gatherer.msm.Declarations
- dec() - Method in class org.greenstone.gatherer.msm.ElementWrapper
- Decrement the number of occurances of this metadata element.
- dec() - Method in class org.greenstone.gatherer.msm.Metadata
- Decrease the reference count by 1.
- description - Variable in class org.greenstone.gatherer.msm.MDSFileFilter
- description - Variable in class org.greenstone.gatherer.msm.MetadataSet
- The description of this metadata set.
- destroy() - Method in class org.greenstone.gatherer.msm.GDMManager
- Destructor necessary for clean exit, subsequent to saving of metadata.xml files.
- destroy() - Method in class org.greenstone.gatherer.msm.GDMParser
- Destructor, clears cache and remove persistant global references.
- destroy() - Method in class org.greenstone.gatherer.msm.MSMProfiler
- Destructor to ensure that no memory leaks.
- destroy() - Method in class org.greenstone.gatherer.msm.MSMPrompt.MSMDialog
- destroy() - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Destructor.
- dialog - Variable in class org.greenstone.gatherer.msm.MSMPrompt.AddListener
- dialog - Variable in class org.greenstone.gatherer.msm.MSMPrompt.CancelListener
- dialog - Variable in class org.greenstone.gatherer.msm.MSMPrompt.IgnoreListener
- dialog - Variable in class org.greenstone.gatherer.msm.MSMPrompt.MergeListener
- dialog - Variable in class org.greenstone.gatherer.msm.MSMPrompt
- dialog_cancelled - Variable in class org.greenstone.gatherer.msm.MSMPrompt
- display() - Method in class org.greenstone.gatherer.msm.ExportMDSPrompt
- Show the prompt and get the user input.
- document - Variable in class org.greenstone.gatherer.msm.MetadataSet
- The Document of the DOM model.
E
- EXPORT - Static variable in class org.greenstone.gatherer.msm.ExportMDSPrompt
- The default export action (there are several depending on how much information you wish to export).
- EXPORT_SIZE - Static variable in class org.greenstone.gatherer.msm.ExportMDSPrompt
- The default size for this dialog window.
- ElementWrapper - class org.greenstone.gatherer.msm.ElementWrapper.
- This class provides a convience wrapper around a DOM model Element to allow Components such as the MetadataTable to display this information properly.
- ElementWrapper(Element) - Constructor for class org.greenstone.gatherer.msm.ElementWrapper
- Constructor for elements with no namespace necessary.
- ExistingMetadataLoader - class org.greenstone.gatherer.msm.ExistingMetadataLoader.
- Attempts to locate and import any metadata already attatched to files about to be imported.
- ExistingMetadataLoader() - Constructor for class org.greenstone.gatherer.msm.ExistingMetadataLoader
- Constructor.
- ExportMDSPrompt - class org.greenstone.gatherer.msm.ExportMDSPrompt.
- A GUI component for allowing the user to export a metadata set, based on certain conditions, and to a certain file (not necessarily a .mds file).
- ExportMDSPrompt(MetadataSetManager, boolean) - Constructor for class org.greenstone.gatherer.msm.ExportMDSPrompt
- Constructor.
- editMDS() - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Method called to open a metadata set editing window.
- element - Variable in class org.greenstone.gatherer.msm.ElementWrapper
- The DOM element this wrapper is wrapped around.
- element - Variable in class org.greenstone.gatherer.msm.MSMEvent
- The element associated with this event.
- element - Variable in class org.greenstone.gatherer.msm.MSMPrompt.MergeListener
- element - Variable in class org.greenstone.gatherer.msm.Metadata
- The metadata element this metadata maps to.
- elementChanged(MSMEvent) - Method in class org.greenstone.gatherer.msm.GDMManager
- Method that is called whenever an element within a set is changed or modified.
- elementChanged(MSMEvent) - Method in class org.greenstone.gatherer.msm.MSMAdapter
- Method that is called whenever an element within a set is changed or modified.
- elementChanged(MSMEvent) - Method in interface org.greenstone.gatherer.msm.MSMListener
- Method that is called whenever an element within a set is changed or modified.
- elementChanged(MSMEvent) - Method in class org.greenstone.gatherer.msm.MSMListenerAdapter
- Method that is called whenever an element within a set is changed or modified.
- elementChanged(MSMEvent) - Method in class org.greenstone.gatherer.msm.MSMProfiler
- Method that is called whenever an element within a set is changed or modified, in which case we must modify the action profiles to suit.
- elementChanged(MSMEvent) - Method in class org.greenstone.gatherer.msm.MetadataComboBoxModel
- Called whenever a metadata element is changed.
- element_combobox - Variable in class org.greenstone.gatherer.msm.MSMPrompt.SetListener
- element_name - Variable in class org.greenstone.gatherer.msm.MSMPrompt.SetListener
- elements - Variable in class org.greenstone.gatherer.msm.MetadataSet
- The list of metadata elements which are, of course, children of the root node.
- elementsEqual(MetadataSet, Element, MetadataSet, Element, boolean) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- Method to compare two metadata elements (of type Element, which is bound to get more than a bit confusing) for equality.
- endMerge() - Method in class org.greenstone.gatherer.msm.MSMPrompt
- Method called when the merging process is complete and the progress bar is no longer needed.
- equals(Object) - Method in class org.greenstone.gatherer.msm.ElementWrapper
- Test if two ElementWrappers are equal.
- equals(Object) - Method in class org.greenstone.gatherer.msm.MSMUtils.MetadataComparator
- Indicates whether some other object is "equal to" this Comparator.
- equals(Object) - Method in class org.greenstone.gatherer.msm.Metadata
- Tests to metadata objects for equality.
- export - Variable in class org.greenstone.gatherer.msm.ExportMDSPrompt
- Is this an export prompt or an import one?
- exportMDS() - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- This method is called to export a metadata set.
- export_button - Variable in class org.greenstone.gatherer.msm.ExportMDSPrompt
- Used to initiate the export, then dispose of the dialog.
- extractMetadata(File) - Method in class org.greenstone.gatherer.msm.GreenstoneArchiveParser
- extractMetadataElements(File) - Static method in class org.greenstone.gatherer.msm.GreenstoneArchiveParser
F
- FILENAME_ELEMENT - Static variable in class org.greenstone.gatherer.msm.GDMDocument
- FILESET_ELEMENT - Static variable in class org.greenstone.gatherer.msm.GDMDocument
- FORCE_MERGE - Static variable in class org.greenstone.gatherer.msm.Declarations
- An element of the action type enumeration.
- file - Variable in class org.greenstone.gatherer.msm.ExportMDSPrompt
- The file we wish to export the metadata set to.
- file - Variable in class org.greenstone.gatherer.msm.GDMManager.MetadataXMLFileSearch
- file - Variable in class org.greenstone.gatherer.msm.MSMEvent
- The file associated with this event.
- file - Variable in class org.greenstone.gatherer.msm.Metadata
- The file for which this metadata was retrieved.
- file - Variable in class org.greenstone.gatherer.msm.MetadataSet
- The File this metadata set was loaded from.
- file_level - Variable in class org.greenstone.gatherer.msm.Metadata
- Indicates what level of metadata this is, relative to the file it was retrieved for.
- file_name - Variable in class org.greenstone.gatherer.msm.ExportMDSPrompt
- The destination file name as a string.
- filename - Variable in class org.greenstone.gatherer.msm.GDMManager.MetadataXMLFileSearch
- fireElementChanged(MSMEvent) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Fire an element changed message off to all registered listeners.
- fireMetadataChanged(FileNode, Metadata, Metadata) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Fire a metadata value changed message, whose id is to be generated now, and whose action code is -1, off to all registered listeners.
- fireMetadataChanged(FileNode, Metadata, Metadata, int) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Fire a metadata value changed message, whose id is to be generated now, off to all registered listeners.
- fireMetadataChanged(long, FileNode, Metadata, Metadata) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Fire a metadata value changed message off to all registered listeners.
- fireMetadataChanged(long, FileNode, Metadata, Metadata, int) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- fireSetChanged(MetadataSet) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Fire a metadata set changed message off to all registered listeners.
- fireValueChanged(ElementWrapper, GValueModel, GValueModel) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Called whenever the value tree associated with an element changes significantly.
G
- GDMDocument - class org.greenstone.gatherer.msm.GDMDocument.
- This class wraps around a DOM Document providing methods for accessing the data within.
- GDMDocument() - Constructor for class org.greenstone.gatherer.msm.GDMDocument
- Constructor which creates a brand new metadata.xml document.
- GDMDocument(File) - Constructor for class org.greenstone.gatherer.msm.GDMDocument
- Constructor which parses an existing metadata.xml document.
- GDMDocument(Document) - Constructor for class org.greenstone.gatherer.msm.GDMDocument
- Constructor which wraps around an existing metadata.xml document.
- GDMManager - class org.greenstone.gatherer.msm.GDMManager.
- This object manages the metadata attached to file records.
- GDMManager() - Constructor for class org.greenstone.gatherer.msm.GDMManager
- Constructor.
- GDMManager.MetadataXMLFileSearch - class org.greenstone.gatherer.msm.GDMManager.MetadataXMLFileSearch.
- GDMManager.MetadataXMLFileSearch(File, String) - Constructor for class org.greenstone.gatherer.msm.GDMManager.MetadataXMLFileSearch
- GDMParser - class org.greenstone.gatherer.msm.GDMParser.
- Parses metadata.xml documents of the GreenstoneDirectoryMetadata variety, caching where possible.
- GDMParser() - Constructor for class org.greenstone.gatherer.msm.GDMParser
- Default constructor.
- GDMParser(int) - Constructor for class org.greenstone.gatherer.msm.GDMParser
- Constructor with maximum size set.
- GreenstoneArchiveParser - class org.greenstone.gatherer.msm.GreenstoneArchiveParser.
- GreenstoneArchiveParser(GShellProgressMonitor, GShell) - Constructor for class org.greenstone.gatherer.msm.GreenstoneArchiveParser
- gdm_parser - Variable in class org.greenstone.gatherer.msm.MetadataSetManager
- Specialized parser for parsing GreenstoneDirectoryMetadata files, which not only caches entries, but also breaks up massive metadata.xml files into reasonable sizes.
- getAbsoluteValue() - Method in class org.greenstone.gatherer.msm.Metadata
- Determine the absolute path value of this metadata, taking into account whether this value is hierarchical.
- getAction() - Method in class org.greenstone.gatherer.msm.MSMAction
- Method for retrieving the appropriate action from this class.
- getAction() - Method in class org.greenstone.gatherer.msm.MSMEvent
- Retrieve the code of the user action that fired this event.
- getAction(String, String) - Method in class org.greenstone.gatherer.msm.MSMProfiler
- Search the profilerer for any previous actions regarding the indicated collection and metadata element.
- getActions(String) - Method in class org.greenstone.gatherer.msm.MSMProfiler
- getAllMetadata(File) - Method in class org.greenstone.gatherer.msm.GDMManager
- getAssignedElements() - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Builds a list of elements that have been assigned as metadata in this collection.
- getAssignedElements(boolean) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Builds a list of elements that have been assigned as metadata in this collection.
- getAssignedValuesDetails(MetadataSet, Element) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- This method extracts the assigned value trees details, if any, from a certain element and stores them in an array ready to be passed as arguments to the Dictionary.
- getAttributeCount(Node) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- Method to count the number of Attribute nodes under a certain Element.
- getAttributeNodeNamed(Node, String) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- This method is a slight variation on getNodeNamed in that it is especially written to retrieve the attribute Nodes of a certain name present under the given element.
- getAttributeNodesNamed(Node, String) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- This method is a slight variation on getNodeNamed in that it is especially written to retrieve the attribute Nodes of a certain name present under the given element.
- getAttributes() - Method in class org.greenstone.gatherer.msm.ElementWrapper
- Retrieve the attributes associated with the element this element wrapper is built around.
- getAttributes(Element) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- getAttributes() - Method in class org.greenstone.gatherer.msm.MetadataSet
- getCollections() - Method in class org.greenstone.gatherer.msm.MSMProfiler
- getCount() - Method in class org.greenstone.gatherer.msm.Metadata
- Retrieve the reference count.
- getCreator() - Method in class org.greenstone.gatherer.msm.MetadataSet
- Method to retrieve the name of the creator of this metadata set.
- getDefaultValueNode(ElementWrapper, String) - Static method in class org.greenstone.gatherer.msm.Metadata
- Retrieve the value node associated with a certain value string.
- getDescription() - Method in class org.greenstone.gatherer.msm.MDSFileFilter
- Retrieve the description for this filter.
- getDescription(Node) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- Method to construct an elements description by retrieving the correct attribute.
- getDescription() - Method in class org.greenstone.gatherer.msm.MetadataSet
- Method to retrieve the description of this metadata set.
- getDocument() - Method in class org.greenstone.gatherer.msm.GDMDocument
- Retrieve the document this class is wrapping.
- getDocument(File) - Method in class org.greenstone.gatherer.msm.GDMManager
- Retrieve the GreenstoneMetadataDocument that is associated with a certain file.
- getDocument() - Method in class org.greenstone.gatherer.msm.MetadataSet
- Method to retrieve the Document associated with this metadata set.
- getElement() - Method in class org.greenstone.gatherer.msm.ElementWrapper
- Retrieve the element this is wrapped around.
- getElement() - Method in class org.greenstone.gatherer.msm.MSMEvent
- Method to retrieve of the element associated with this event.
- getElement() - Method in class org.greenstone.gatherer.msm.Metadata
- Retrieve the element associated with this metadata.
- getElement(int) - Method in class org.greenstone.gatherer.msm.MetadataSet
- Method to retrieve the metadata element indicated by an index.
- getElement(Metadata) - Method in class org.greenstone.gatherer.msm.MetadataSet
- This method is used to acquire a reference to the element which matches the given metadata.
- getElement(String) - Method in class org.greenstone.gatherer.msm.MetadataSet
- This method is used to acquire a reference to the element which has the name specified.
- getElement(Element, String) - Method in class org.greenstone.gatherer.msm.MetadataSet
- getElement(int) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Retrieve a metadata element by its index.
- getElement(ElementWrapper) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Retrieve a metadata element by looking at the current metadata element.
- getElement(String) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Retrieve a metadata element by its fully qualified name.
- getElement(String, boolean) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- getElement(String, String) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Retrieve a certain named element from a certain named set.
- getElementModel() - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Returns all the elements within this set as a combobox model.
- getElements() - Method in class org.greenstone.gatherer.msm.MetadataSet
- Method to acquire a list of all the elements in this metadata set.
- getElements() - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Used to get all the (non-hidden) elements in this manager.
- getElements(boolean) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- getElements(boolean, boolean) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Used to get all the elements in this manager.
- getElementsSorted() - Method in class org.greenstone.gatherer.msm.MetadataSet
- Method to retrieve a list of all the elements in this metadata set, sorted.
- getFile() - Method in class org.greenstone.gatherer.msm.MSMEvent
- getFile() - Method in class org.greenstone.gatherer.msm.Metadata
- Retrieve the source file if any.
- getFile() - Method in class org.greenstone.gatherer.msm.MetadataSet
- Method to retrieve the original file this metadata set was created from.
- getFullName(Element) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- Method to construct an elements fully qualified name.
- getFullName(Element, String) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- Method to construct an elements fully qualified name.
- getFullValue(String) - Method in class org.greenstone.gatherer.msm.LegacyCollectionImporter.HFile
- getIdentifier(Node) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- Method to construct an elements identifier by retrieving the correct attribute.
- getIdentity() - Method in class org.greenstone.gatherer.msm.ElementWrapper
- Retrieve the identity of this element (not necessary the same as this elements name).
- getLastChanged() - Method in class org.greenstone.gatherer.msm.MetadataSet
- Get the last changed attribute.
- getListCellRendererComponent(JList, Object, int, boolean, boolean) - Method in class org.greenstone.gatherer.msm.MSMPrompt.AttributeListCellRenderer
- getMetadata(String, boolean, ArrayList, File, boolean) - Method in class org.greenstone.gatherer.msm.GDMDocument
- Get all of the metadata, including directory level, associated with this file.
- getMetadata(String, boolean, ArrayList, File, boolean, boolean) - Method in class org.greenstone.gatherer.msm.GDMDocument
- Retrieve the metadata associated with the given filename.
- getMetadata(File) - Method in class org.greenstone.gatherer.msm.GDMManager
- Recover the metadata associated with a particular file.
- getMetadata(File, ElementWrapper) - Method in class org.greenstone.gatherer.msm.GDMManager
- getMetadata(File, boolean, boolean) - Method in class org.greenstone.gatherer.msm.GDMManager
- getMetadataOnly(File) - Method in class org.greenstone.gatherer.msm.GDMManager
- Recover the metadata associated with a particular file excluding folder level metadata.
- getName() - Method in class org.greenstone.gatherer.msm.ElementWrapper
- Retrieve the name of this element.
- getName() - Method in class org.greenstone.gatherer.msm.MetadataSet
- Method to get this metadata sets name.
- getNamespace() - Method in class org.greenstone.gatherer.msm.ElementWrapper
- Retrieve the namespace prefix for this element wrapper.
- getNamespace() - Method in class org.greenstone.gatherer.msm.MetadataSet
- Method to retrieve this metadata sets namespace.
- getNewMetadata() - Method in class org.greenstone.gatherer.msm.MSMEvent
- Method to retrieve the new metadata associated with this event.
- getNodeFromNamed(Node, String) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- Method to retrieve from the node given, a certain child node with the specified name.
- getOccurances() - Method in class org.greenstone.gatherer.msm.ElementWrapper
- Look for the occurances 'field' of the element and return it if found.
- getOccurances(Element) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- Look for the occurances 'field' of the element and return it if found.
- getOldMetadata() - Method in class org.greenstone.gatherer.msm.MSMEvent
- Method to retrieve the old metadata associated with this event.
- getOptionListDetails(Element) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- This method extracts the option list details, if any, from a certain element and stores them in an array ready to be passed as arguments to the Dictionary.
- getPath(Node, Node) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- This method traces the path between the 'root' node given and the target node.
- getRecord() - Method in class org.greenstone.gatherer.msm.MSMEvent
- Retrieve the record associated with this event.
- getRoot() - Method in class org.greenstone.gatherer.msm.MetadataSet
- Method to retrieve the root element, i.e.
- getSelectedCondition() - Method in class org.greenstone.gatherer.msm.ExportMDSPrompt
- Get the current value of condition.
- getSelectedFile() - Method in class org.greenstone.gatherer.msm.ExportMDSPrompt
- Get the current value of file.
- getSelectedSet() - Method in class org.greenstone.gatherer.msm.ExportMDSPrompt
- Get the current value of set.
- getSet() - Method in class org.greenstone.gatherer.msm.MSMAction
- getSet(String) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Retrieve the named metadata set.
- getSets() - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Method to retrieve all of the metadata sets loaded in this collection.
- getSets(boolean) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- getSize() - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Find the total number of elements loaded.
- getSource() - Method in class org.greenstone.gatherer.msm.MSMAction
- getSources(String) - Method in class org.greenstone.gatherer.msm.MSMProfiler
- getStructuralDetails(MetadataSet, Element) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- This method extracts the structural details from a certain element and stores them in an array, all ready for passing to the Dictionary.
- getToolTip() - Method in class org.greenstone.gatherer.msm.ElementWrapper
- This method is essentially the same as getDescription() in that it does indeed return this metaelements description.
- getValue() - Method in class org.greenstone.gatherer.msm.MSMEvent
- Retrieve the associated with this event.
- getValue(Node) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- Method to retrieve the value of a given node (not the assigned values tree!).
- getValue() - Method in class org.greenstone.gatherer.msm.Metadata
- Get the textual value of this metadata.
- getValueMappings(Node, String, Hashtable) - Static method in class org.greenstone.gatherer.msm.MSMUtils
- Method to traverse the given value tree, and build up a hashtable of mappings between the value path key names and the Subject nodes of the tree.
- getValueNode() - Method in class org.greenstone.gatherer.msm.Metadata
- Retrieve the value node associated with this metadata.
- getValueTree(ElementWrapper) - Method in class org.greenstone.gatherer.msm.MetadataSet
- Retrieve the value tree from this set that matches the given element.
- getValueTree(ElementWrapper) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Get the value tree that matches the given element.
- getValueTreeTemplate() - Static method in class org.greenstone.gatherer.msm.MSMUtils
- Parses the value tree template file.
H
- HFILE - Static variable in class org.greenstone.gatherer.msm.Declarations
- An element of the action type enumeration.
- HIDDEN - Static variable in class org.greenstone.gatherer.msm.MetadataSetManager
- The name of the hidden, or system, metadata set.
- HVALUE_ATTRIBUTE - Static variable in class org.greenstone.gatherer.msm.GDMDocument
- hasValueTree() - Method in class org.greenstone.gatherer.msm.ElementWrapper
- hfile - Variable in class org.greenstone.gatherer.msm.MSMAction
I
- ID() - Method in class org.greenstone.gatherer.msm.MSMEvent
- IGNORE - Static variable in class org.greenstone.gatherer.msm.MSMProfiler
- IMPORT_SIZE - Static variable in class org.greenstone.gatherer.msm.ExportMDSPrompt
- The default size for this dialog window.
- id - Variable in class org.greenstone.gatherer.msm.MSMEvent
- A unique id given to any file or metadata task so it can be undone in its entirity.
- ignore - Variable in class org.greenstone.gatherer.msm.GDMParser
- A list of file names that we know do not actually belong to valid GDM xml files, so there not much point in ever trying to read them again.
- ignore_list - Static variable in class org.greenstone.gatherer.msm.GreenstoneArchiveParser
- importMDS() - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- This method is called to import a metadata set.
- importMDS(File, boolean) - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- importMetadata() - Method in class org.greenstone.gatherer.msm.LegacyCollectionImporter
- importMetadata(File) - Method in class org.greenstone.gatherer.msm.LegacyCollectionImporter
- Processes the files in the import tree, editing metadata.xml files so they contain namespaced element names.
- inc() - Method in class org.greenstone.gatherer.msm.ElementWrapper
- Increment the number of occurances of this metadata element.
- inc() - Method in class org.greenstone.gatherer.msm.Metadata
- Increase the reference count by 1.
- incrementMerge() - Method in class org.greenstone.gatherer.msm.MSMPrompt
- Method to indicate that yet another element has been succesfully merged, so that progress bar should reflect this.
- init() - Method in class org.greenstone.gatherer.msm.MetadataComboBoxModel
- init(File) - Method in class org.greenstone.gatherer.msm.MetadataSet
- isExtracted() - Method in class org.greenstone.gatherer.msm.ElementWrapper
- isFileLevel() - Method in class org.greenstone.gatherer.msm.Metadata
- Determine if this metadata is file level or folder level.
- isHierarchy() - Method in class org.greenstone.gatherer.msm.ElementWrapper
- isUpToDate() - Method in class org.greenstone.gatherer.msm.GDMDocument
- Determine if this document has been saved recently, and thus xml file version is up to date.
- isValid() - Method in class org.greenstone.gatherer.msm.GDMDocument
- Determine is this is a valid Greenstone Directory Metadata file.
- is_extracted - Variable in class org.greenstone.gatherer.msm.ElementWrapper
K
- keyPressed(KeyEvent) - Method in class org.greenstone.gatherer.msm.ExportMDSPrompt
- Any implementation of KeyListener must include this method so that we can be informed when a key has been pressed.
- keyReleased(KeyEvent) - Method in class org.greenstone.gatherer.msm.ExportMDSPrompt
- Any implementation of KeyListener must include this method so that we can be informed once a key has been released.
- keyTyped(KeyEvent) - Method in class org.greenstone.gatherer.msm.ExportMDSPrompt
- Any implementation of KeyListener must include this method so that we can be informed when a key has been typed.
L
- LegacyCollectionImporter - class org.greenstone.gatherer.msm.LegacyCollectionImporter.
- Importing metadata from legacy collections requires three distinct steps: 1.
- LegacyCollectionImporter(File, CollectionDesignManager) - Constructor for class org.greenstone.gatherer.msm.LegacyCollectionImporter
- Constructor.
- LegacyCollectionImporter.HFile - class org.greenstone.gatherer.msm.LegacyCollectionImporter.HFile.
- Another basic HFile wrapper.
- LegacyCollectionImporter.HFile(ElementWrapper, File) - Constructor for class org.greenstone.gatherer.msm.LegacyCollectionImporter.HFile
- LegacyCollectionImporter.HFile.Entry - class org.greenstone.gatherer.msm.LegacyCollectionImporter.HFile.Entry.
- LegacyCollectionImporter.HFile.Entry(String, String) - Constructor for class org.greenstone.gatherer.msm.LegacyCollectionImporter.HFile.Entry
- list - Variable in class org.greenstone.gatherer.msm.MSMPrompt.ElementListListener
- The list from whom we are listening for selection events.
- listeners - Variable in class org.greenstone.gatherer.msm.MetadataSetManager
- A list of classes who are interested in changes to the loaded metadata sets.
- load(Document) - Method in class org.greenstone.gatherer.msm.MSMProfiler
- Reload the mapping information stored in this document.
- load() - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- This method reloads all of the metadata sets that have been marked as included in this collection by entries in the collection configuration file.
- loadProfiler() - Method in class org.greenstone.gatherer.msm.MetadataSetManager
- Creates a new profiler, which in turn will attempt to load previous profile information.
- loader - Variable in class org.greenstone.gatherer.msm.MetadataSetManager
- The loader responsible for sequentially loading and attempting to use all registered metadata parsers to extract existing metadata from new files.
M
- MAX_DOCUMENTS - Static variable in class org.greenstone.gatherer.msm.GDMManager
- The maximum number of GDMDocuments to load at any one time
- MDE_SIZE - Static variable in class org.greenstone.gatherer.msm.MSMPrompt
- MDSFileFilter - class org.greenstone.gatherer.msm.MDSFileFilter.
- A custom FileFilter for the file choosers.
- MDSFileFilter() - Constructor for class org.greenstone.gatherer.msm.MDSFileFilter
- Constructor.
- MDS_SIZE - Static variable in class org.greenstone.gatherer.msm.MSMPrompt
- MERGE - Static variable in class org.greenstone.gatherer.msm.Declarations
- An element of the action type enumeration.
- METADATA_COMPARATOR - Static variable in class org.greenstone.gatherer.msm.MSMUtils
- Used to order metadata according to set standard element order then alphabetically by value.
- MODE_ATTRIBUTE - Static variable in class org.greenstone.gatherer.msm.GDMDocument
- MSMAction - class org.greenstone.gatherer.msm.MSMAction.
- This class provides all the information required to correctly perform metadata actions, with regard to the users previously indicated preferences in terms of importing and renaming.
- MSMAction(int, String) - Constructor for class org.greenstone.gatherer.msm.MSMAction
- Constructor.
- MSMAction(int, String, boolean) - Constructor for class org.greenstone.gatherer.msm.MSMAction
- Constructor.
- MSMAction(String, String, int, String) - Constructor for class org.greenstone.gatherer.msm.MSMAction
- MSMAdapter - class org.greenstone.gatherer.msm.MSMAdapter.
- The default adapter for a MSMListener doesn't actually do anything, thus users can override whatever methods they want.
- MSMAdapter() - Constructor for class org.greenstone.gatherer.msm.MSMAdapter
- MSMEvent - class org.greenstone.gatherer.msm.MSMEvent.
- An event object which contains useful information about the event that generated it, which in this case is probably an element update (this means a MSMAction object should be provided).
- MSMEvent(Object, long, ElementWrapper, GValueModel, GValueModel) - Constructor for class org.greenstone.gatherer.msm.MSMEvent
- Constructor.
- MSMEvent(Object, long, File, Metadata, Metadata) - Constructor for class org.greenstone.gatherer.msm.MSMEvent
- Constructor for a metadata change event involving a file.
- MSMEvent(Object, long, FileNode, Metadata, Metadata, int) - Constructor for class org.greenstone.gatherer.msm.MSMEvent
- Constructor for a metadata change event involving a filenode.
- MSMEvent(Object, long, MSMAction) - Constructor for class org.greenstone.gatherer.msm.MSMEvent
- Constructor.
- MSMEvent(Object, ElementWrapper, String) - Constructor for class org.greenstone.gatherer.msm.MSMEvent
- Constructor for a metadata element changed event.
- MSMListener - interface org.greenstone.gatherer.msm.MSMListener.
- This class provides an interface for classes who wish to listener for events within the MetadataSetManager.
- MSMListenerAdapter - class org.greenstone.gatherer.msm.MSMListenerAdapter.
- This class provides an interface for classes who wish to listener for events within the MetadataSetManager.
- MSMListenerAdapter() - Constructor for class org.greenstone.gatherer.msm.MSMListenerAdapter
- MSMProfiler - class org.greenstone.gatherer.msm.MSMProfiler.
- This class is essentially records what actions a user took when merging two metadata sets, so we can avoid having to get the user to repeat the proceedure.
- MSMProfiler() - Constructor for class org.greenstone.gatherer.msm.MSMProfiler
- The constructor loads the previous profile for this collection if there is one.
- MSMPrompt - class org.greenstone.gatherer.msm.MSMPrompt.
- A class dedicated to producing the visual components used by the MSM package.
- MSMPrompt(MetadataSetManager) - Constructor for class org.greenstone.gatherer.msm.MSMPrompt
- MSMPrompt.AddListener - class org.greenstone.gatherer.msm.MSMPrompt.AddListener.
- Prompts the user to select a metadata set from the given list.
- MSMPrompt.AddListener(JDialog, String, JComboBox) - Constructor for class org.greenstone.gatherer.msm.MSMPrompt.AddListener
- MSMPrompt.AttributeListCellRenderer - class org.greenstone.gatherer.msm.MSMPrompt.AttributeListCellRenderer.
- a ListCellRenderer for a list of Elements - the displayed value of the element is not Element.toString()
- MSMPrompt.AttributeListCellRenderer() - Constructor for class org.greenstone.gatherer.msm.MSMPrompt.AttributeListCellRenderer
- MSMPrompt.CancelListener - class org.greenstone.gatherer.msm.MSMPrompt.CancelListener.
- MSMPrompt.CancelListener(JDialog) - Constructor for class org.greenstone.gatherer.msm.MSMPrompt.CancelListener
- MSMPrompt.ElementListListener - class org.greenstone.gatherer.msm.MSMPrompt.ElementListListener.
- This listener listens for selections within the select element to merge prompt, and once one has been made enables the ok button.
- MSMPrompt.ElementListListener(JList, JButton) - Constructor for class org.greenstone.gatherer.msm.MSMPrompt.ElementListListener
- Constructor.
- MSMPrompt.IgnoreListener - class org.greenstone.gatherer.msm.MSMPrompt.IgnoreListener.
- MSMPrompt.IgnoreListener(JDialog) - Constructor for class org.greenstone.gatherer.msm.MSMPrompt.IgnoreListener
- MSMPrompt.MSMDialog - class org.greenstone.gatherer.msm.MSMPrompt.MSMDialog.
- MSMPrompt.MSMDialog() - Constructor for class org.greenstone.gatherer.msm.MSMPrompt.MSMDialog
- MSMPrompt.MergeListener - class org.greenstone.gatherer.msm.MSMPrompt.MergeListener.
- MSMPrompt.MergeListener(JDialog, JComboBox) - Constructor for class org.greenstone.gatherer.msm.MSMPrompt.MergeListener
- MSMPrompt.SetListener - class org.greenstone.gatherer.msm.MSMPrompt.SetListener.
- Listens to changes in the metadata set combobox
- MSMPrompt.SetListener(JComboBox, JComboBox, String, JButton, JButton) - Constructor for class org.greenstone.gatherer.msm.MSMPrompt.SetListener
- MSMUtils - class org.greenstone.gatherer.msm.MSMUtils.
- This class contains a plethora of methods associated with handling the content of MetadataSets and the Elements within.
- MSMUtils() - Constructor for class org.greenstone.gatherer.msm.MSMUtils
- MSMUtils.MetadataComparator - class org.greenstone.gatherer.msm.MSMUtils.MetadataComparator.
- A comparator for sorting metadata element-value pairs into their standard order (elements) then alphabetical order (values).
- MSMUtils.MetadataComparator() - Constructor for class org.greenstone.gatherer.msm.MSMUtils.MetadataComparator
- Metadata - class org.greenstone.gatherer.msm.Metadata.
- Stores a mapping between a particular metadata element, and a certain value node.
- Metadata(ElementWrapper) - Constructor for class org.greenstone.gatherer.msm.Metadata
- Constructs a new Metadata object with no current value.