DleseXMLReader (DLESE Tools API Documentation v1.6.0)

java.lang.Object
- org.dlese.dpc.xml.maps.DleseXMLReader

All Implemented Interfaces:

XMLMap
```
public class DleseXMLReader
extends java.lang.Object
implements XMLMap
```
This class provides mapping between DLESE metadata values and the corresponding XML metadata record.
The accessor methods act as an interface with the XMLNode and XMLRecord classes. The XML processing details are handled by those classes, but the one requirement of this class is to have knowledge of the paths structure. Paths are used as keys into the XMLRecord map.

Version:

0.9b, 05/20/02

Author:

Dave Deniman

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`isValid` boolean value indicates success of initialization
`protected java.util.HashMap`	`map` mapping of user-defined names to metadata values
`protected java.io.File`	`xmlFile` source XML file
`protected XMLRecord`	`xmlRecord` convenience abstraction of the XML DOM

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DleseXMLReader()` Default constructor is restricted to assure that a file directory is provided on object creation.
	`DleseXMLReader(java.io.File xmlfile)`
	`DleseXMLReader(java.lang.String filepath)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`destroy()` Releases all resources and calls finalize method.
`protected java.lang.String`	`getAccessionedDate()` Retrieves the date the catalog record was created.
`protected java.util.List`	`getAnnotations()` Retrieves the list of lifecycle contributors to a resource from the current record.
`protected java.util.List`	`getAudiences()` Retrieves the list of intended audiences for a resource from the current record.
`protected java.lang.String`	`getComment(java.lang.String key, java.lang.String identifier)` Retrieves a specific comment from the XML node identified by the key.
`protected java.lang.String`	`getCopyright()` Retreives the copright information of a resource from the current record.
`protected java.lang.String`	`getCost()` Retrieves the cost information of a resource from the current record.
`protected java.lang.String`	`getCreatedDate()` Retrieves the date the catalog record was created.
`protected java.lang.String`	`getDescription()` Retreives the description of a resource from the current record.
`protected java.util.List`	`getGeographyStds()` Retrieves the list of geography standards defined for the current resource.
`protected java.util.List`	`getGeoReferences()` Retrieves the list of georeferences for a resource from the current record.
`protected java.lang.String`	`getID()` Retrieves the record ID from XML file.
`protected java.lang.String`	`getInformation()` Retrieves the additional information from the footnote comment of the current record.
`java.lang.String`	`getInitErrorMsg()` Gets a message describing the initialization error or empty string if no error occured.
`java.util.List`	`getKeys()` Retrieves a list the keys contained in the map.
`protected java.util.List`	`getKeywords()` Gets the keywords attribute of the DleseXMLReader object
`protected java.util.List`	`getLifecycleContributors()` Retrieves the list of lifecycle contributors to a resource from the current record.
`protected java.util.List`	`getMetametadataContributors()` Retrieves the list of metadata contributors for a resource from the current record.
`protected java.lang.String`	`getOtherTechnicalInfo()` Gets the otherTechnicalInfo attribute of the DleseXMLReader object
`protected java.util.List`	`getRelations()` Retrieves the list of lifecycle contributors to a resource from the current record.
`protected java.util.List`	`getResourceTypes()` Retrieves the list of learning resource types for a resource from the current record.
`protected java.lang.String`	`getResourceURL()` Retrieves the URL of the reource this record catalogs.
`protected java.util.List`	`getScienceStds()` Retrieves the list of intended audiences for a resource from the current record.
`protected java.lang.String`	`getStringValue(java.lang.String key)` Retrieves text content from the XML node identified by the key.
`protected java.util.List`	`getSubjects()` Retrieves the list of subjects specified for a resource from the current record.
`protected java.util.List`	`getTechnicalFormats()` Gets the technicalFormats attribute of the DleseXMLReader object
`protected java.util.List`	`getTechnicalReqs()` Retrieves the list of technical requirements for a resource from the current record.
`protected java.lang.String`	`getTitle()` Retreives the resource title from the current record.
`protected java.util.List`	`getURLs()` Retrieves the list of subjects specified for a resource from the current record.
`java.lang.Object`	`getValue(java.lang.String name)` Getter method to retrieve a specific metadata value.
`java.util.List`	`getValues()` Retrieves the list of metadata values held in the map.
`boolean`	`init()` Creates `XMLRecord` and intializes local map.
`protected void`	`insertToList(java.util.List list, java.lang.Object o)` Simple insertion routine for constructing an ordered list of Objects
`protected void`	`insertToList(java.util.List list, java.lang.String s)` Simple insertion sort for building a sorted list of Strings.
`void`	`setMap()` After successful initialization, this method creates the map of actual name:value pairs defined within this specific `XMLMap` instance.
`void`	`setValue(java.lang.String name, java.lang.Object xmlObject)` Setter method for setting a specific metadata value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - isValid
```
protected boolean isValid
```
    boolean value indicates success of initialization
  - xmlFile
```
protected java.io.File xmlFile
```
    source XML file
  - xmlRecord
```
protected XMLRecord xmlRecord
```
    convenience abstraction of the XML DOM
  - map
```
protected java.util.HashMap map
```
    mapping of user-defined names to metadata values
- Constructor Detail
  - DleseXMLReader
```
protected DleseXMLReader()
```
    Default constructor is restricted to assure that a file directory is provided on object creation.
  - DleseXMLReader
```
public DleseXMLReader(java.io.File xmlfile)
```
    Parameters:
    
    xmlfile -
  - DleseXMLReader
```
public DleseXMLReader(java.lang.String filepath)
```
    Parameters:
    
    filepath - A qualified filepath to a well-formed XML file.
- Method Detail
  - init
```
public boolean init()
```
    Creates XMLRecord and intializes local map. If an error occurs then an error message may be obtained by immediately calling the getInitErrorMsg() method.
    
    Specified by:
    
    init in interface XMLMap
    
    Returns:
    
    true if successful, false otherwise.
  - getInitErrorMsg
```
public java.lang.String getInitErrorMsg()
```
    Gets a message describing the initialization error or empty string if no error occured.
    
    Returns:
    
    The initErrorMsg value
  - destroy
```
public void destroy()
```
    Releases all resources and calls finalize method.
    
    Specified by:
    
    destroy in interface XMLMap
  - getValue
```
public java.lang.Object getValue(java.lang.String name)
```
    Getter method to retrieve a specific metadata value.
    
    Specified by:
    
    getValue in interface XMLMap
    
    Parameters:
    
    name - the user-defined name identifying the specific value to retrieve.
    
    Returns:
    
    the requested value if it exists, null otherwise.
  - setValue
```
public void setValue(java.lang.String name,
                     java.lang.Object xmlObject)
```
    Setter method for setting a specific metadata value.
    
    Specified by:
    
    setValue in interface XMLMap
    
    Parameters:
    
    name - the user-defined name identifying the specific value to update.
    
    xmlObject - the value to assoicate with the specified name.
  - setMap
```
public void setMap()
```
    After successful initialization, this method creates the map of actual name:value pairs defined within this specific XMLMap instance.
    
    Specified by:
    
    setMap in interface XMLMap
  - getKeys
```
public java.util.List getKeys()
```
    Retrieves a list the keys contained in the map.
    
    Specified by:
    
    getKeys in interface XMLMap
    
    Returns:
    
    the list of keys used to hash the metadata values.
  - getValues
```
public java.util.List getValues()
```
    Retrieves the list of metadata values held in the map.
    
    Specified by:
    
    getValues in interface XMLMap
    
    Returns:
    
    the list of values held in the map.
  - getComment
```
protected java.lang.String getComment(java.lang.String key,
                                      java.lang.String identifier)
```
    Retrieves a specific comment from the XML node identified by the key. The comment is specified using an identifier, which may be any portion of the actual comment, or a label which is stored as part of the comment.
    
    Parameters:
    
    key - The path for the desired node.
    
    identifier - A string used to identify the specific comment.
    
    Returns:
    
    The specificied comment.
  - getID
```
protected java.lang.String getID()
```
    Retrieves the record ID from XML file.
    
    Returns:
    
    id ID of record.
  - getResourceURL
```
protected java.lang.String getResourceURL()
```
    Retrieves the URL of the reource this record catalogs.
    
    Returns:
    
    The resource URL, as a string.
  - getCreatedDate
```
protected java.lang.String getCreatedDate()
```
    Retrieves the date the catalog record was created.
    
    Returns:
    
    The catalog record creation date, as a string.
  - getAccessionedDate
```
protected java.lang.String getAccessionedDate()
```
    Retrieves the date the catalog record was created.
    
    Returns:
    
    The catalog record creation date, as a string.
  - getInformation
```
protected java.lang.String getInformation()
```
    Retrieves the additional information from the footnote comment of the current record.
    
    Returns:
    
    The footnote comment.
  - getTitle
```
protected java.lang.String getTitle()
```
    Retreives the resource title from the current record.
    
    Returns:
    
    The resource title.
  - getDescription
```
protected java.lang.String getDescription()
```
    Retreives the description of a resource from the current record.
    
    Returns:
    
    The description as a string.
  - getCost
```
protected java.lang.String getCost()
```
    Retrieves the cost information of a resource from the current record.
    
    Returns:
    
    Cost information as a string.
  - getCopyright
```
protected java.lang.String getCopyright()
```
    Retreives the copright information of a resource from the current record.
    
    Returns:
    
    Copyright information as a string.
  - getOtherTechnicalInfo
```
protected java.lang.String getOtherTechnicalInfo()
```
    Gets the otherTechnicalInfo attribute of the DleseXMLReader object
    
    Returns:
    
    The otherTechnicalInfo value
  - getAudiences
```
protected java.util.List getAudiences()
```
    Retrieves the list of intended audiences for a resource from the current record.
    
    Returns:
    
    List of strings of intended audiences.
  - getTechnicalFormats
```
protected java.util.List getTechnicalFormats()
```
    Gets the technicalFormats attribute of the DleseXMLReader object
    
    Returns:
    
    The technicalFormats value
  - getSubjects
```
protected java.util.List getSubjects()
```
    Retrieves the list of subjects specified for a resource from the current record.
    
    Returns:
    
    List of strings of specified subjects.
  - getURLs
```
protected java.util.List getURLs()
```
    Retrieves the list of subjects specified for a resource from the current record.
    
    Returns:
    
    List of strings of specified subjects.
  - getTechnicalReqs
```
protected java.util.List getTechnicalReqs()
```
    Retrieves the list of technical requirements for a resource from the current record.
    
    Returns:
    
    List of MeccaMain.TechnicalReq objects.
  - getResourceTypes
```
protected java.util.List getResourceTypes()
```
    Retrieves the list of learning resource types for a resource from the current record.
    
    Returns:
    
    List of DleseRecord.ResourceType objects.
  - getMetametadataContributors
```
protected java.util.List getMetametadataContributors()
```
    Retrieves the list of metadata contributors for a resource from the current record.
    
    Returns:
    
    List of DleseRecord.Contributor objects identifying the metadata contributors.
  - getLifecycleContributors
```
protected java.util.List getLifecycleContributors()
```
    Retrieves the list of lifecycle contributors to a resource from the current record.
    
    Returns:
    
    List of DleseRecord.Contributor objects identifying the lifecycle contributors.
  - getAnnotations
```
protected java.util.List getAnnotations()
```
    Retrieves the list of lifecycle contributors to a resource from the current record.
    
    Returns:
    
    List of DleseRecord.Contributor objects identifying the lifecycle contributors.
  - getRelations
```
protected java.util.List getRelations()
```
    Retrieves the list of lifecycle contributors to a resource from the current record.
    
    Returns:
    
    List of DleseRecord.Contributor objects identifying the lifecycle contributors.
  - getGeoReferences
```
protected java.util.List getGeoReferences()
```
    Retrieves the list of georeferences for a resource from the current record.
    
    Returns:
    
    List of DleseRecord.Contributor objects identifying the lifecycle contributors.
  - getKeywords
```
protected java.util.List getKeywords()
```
    Gets the keywords attribute of the DleseXMLReader object
    
    Returns:
    
    The keywords value
  - getGeographyStds
```
protected java.util.List getGeographyStds()
```
    Retrieves the list of geography standards defined for the current resource.
    
    Returns:
    
    List of strings of intended audiences.
  - getScienceStds
```
protected java.util.List getScienceStds()
```
    Retrieves the list of intended audiences for a resource from the current record.
    
    Returns:
    
    List of strings of intended audiences.
  - getStringValue
```
protected java.lang.String getStringValue(java.lang.String key)
```
    Retrieves text content from the XML node identified by the key.
    
    Parameters:
    
    key - The path for the desired node.
    
    Returns:
    
    The text content of the XML node, or an empty string if the node does not exist.
  - insertToList
```
protected void insertToList(java.util.List list,
                            java.lang.String s)
```
    Simple insertion sort for building a sorted list of Strings.
    
    Parameters:
    
    list - List to add an item to.
    
    s - String to add to the list.
  - insertToList
```
protected void insertToList(java.util.List list,
                            java.lang.Object o)
```
    Simple insertion routine for constructing an ordered list of Objects
    
    Parameters:
    
    list - List to add an item to.
    
    o - Object to add to the list.

Class DleseXMLReader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

isValid

xmlFile

xmlRecord

map

Constructor Detail

DleseXMLReader

DleseXMLReader

DleseXMLReader

Method Detail

init

getInitErrorMsg

destroy

getValue

setValue

setMap

getKeys

getValues

getComment

getID

getResourceURL

getCreatedDate

getAccessionedDate

getInformation

getTitle

getDescription

getCost

getCopyright

getOtherTechnicalInfo

getAudiences

getTechnicalFormats

getSubjects

getURLs

getTechnicalReqs

getResourceTypes

getMetametadataContributors

getLifecycleContributors

getAnnotations

getRelations

getGeoReferences

getKeywords

getGeographyStds

getScienceStds

getStringValue

insertToList

insertToList