org.dspace.app.sfx

Class SFXFileReader

java.lang.Object

org.dspace.app.sfx.SFXFileReader

public class SFXFileReader
extends java.lang.Object

XML configuration file reader for DSpace metadata fields (DC) mapping to OpenURL parameters.

This class reads the [dspace]/config/sfx.xml configuration file, which contains pairs of DSpace item metadata values and OpenURL parameter names. Then it takes an item and constructs an OpenURL for it with values of parameters filled in from the paired metadata fields.

Version:

$Revision$

Author:

Stuart Lewis, Graham Triggs

Constructor Summary

Constructors

Constructor and Description
SFXFileReader()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	doNodes(org.w3c.dom.Node node, Item item) Process the item, mapping each of its metadata fields defined in the configuration file to an OpenURL parameter
static java.lang.String	getAttribute(org.w3c.dom.Node e, java.lang.String name) Returns the value of the node's attribute named
static org.w3c.dom.Node	getElement(org.w3c.dom.Node node) Returns element node
static java.lang.String	getValue(org.w3c.dom.Node node) Returns the value found in the Text node (if any) in the node list that's passed in.
static boolean	isEmptyTextNode(org.w3c.dom.Node nd) Is Empty text Node
static java.lang.String	loadSFXFile(java.lang.String fileName, Item item) Loads the SFX configuration file
static org.w3c.dom.Document	parseFile(java.lang.String fileName) Parses XML file and returns XML document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SFXFileReader

public SFXFileReader()

Method Detail

loadSFXFile

public static java.lang.String loadSFXFile(java.lang.String fileName,
                           Item item)
                                    throws java.io.IOException

Loads the SFX configuration file

Parameters:

fileName - The name of the SFX configuration file

item - The item to process, from which metadata values will be taken

Returns:

the SFX string

Throws:

java.io.IOException

parseFile

public static org.w3c.dom.Document parseFile(java.lang.String fileName)

Parses XML file and returns XML document.

Parameters:

fileName - XML file to parse

Returns:

XML document or null if error occured. The error is caught and logged.

doNodes

public static java.lang.String doNodes(org.w3c.dom.Node node,
                       Item item)
                                throws java.io.IOException

Process the item, mapping each of its metadata fields defined in the configuration file to an OpenURL parameter

Parameters:

node - DOM node of the mapping pair in the XML file (field element)

item - The item to process, from which metadata values will be taken

Returns:

processed fields.

Throws:

java.io.IOException

getElement

public static org.w3c.dom.Node getElement(org.w3c.dom.Node node)

Returns element node

Parameters:

node - element (it is XML tag)

Returns:

Element node otherwise null

isEmptyTextNode

public static boolean isEmptyTextNode(org.w3c.dom.Node nd)

Is Empty text Node

getAttribute

public static java.lang.String getAttribute(org.w3c.dom.Node e,
                            java.lang.String name)

Returns the value of the node's attribute named

getValue

public static java.lang.String getValue(org.w3c.dom.Node node)

Returns the value found in the Text node (if any) in the node list that's passed in.