org.dspace.app.itemupdate

Class MetadataUtilities

java.lang.Object

org.dspace.app.itemupdate.MetadataUtilities

public class MetadataUtilities
extends java.lang.Object

Miscellaneous methods for metadata handling that build on the API which might have general utility outside of the specific use in context in ItemUpdate. The XML methods were based on those in ItemImport

Constructor Summary

Constructors

Constructor and Description
MetadataUtilities()

Method Summary

Methods

Modifier and Type	Method and Description
static void	appendMetadata(Item item, org.dspace.app.itemupdate.DtoMetadata dtom, boolean isLanguageStrict, java.lang.String textToAppend) Append text to value metadata field to item
static boolean	deleteMetadataByValue(Item item, org.dspace.app.itemupdate.DtoMetadata dtom, boolean isLanguageStrict) Working around Item API to delete a value-specific DCValue For a given element/qualifier/lang: get all DCValues clear (i.e.
static java.lang.String	getCompoundForm(java.lang.String schema, java.lang.String element, java.lang.String qualifier)
static java.lang.String	getDCValueString(DCValue dcv) Get display of DCValue
static java.util.List<org.dspace.app.itemupdate.DtoMetadata>	loadDublinCore(javax.xml.parsers.DocumentBuilder docBuilder, java.io.InputStream is) Modification of method from ItemImporter.loadDublinCore as a Factory method
static java.lang.String[]	parseCompoundForm(java.lang.String compoundForm) Parses metadata field given in the form .[.|.*] checks for correct number of elements (2 or 3) and for empty strings
static java.util.List<ContentsEntry>	readContentsFile(java.io.File f) Rewrite of ItemImport's functionality but just the parsing of the file, not the processing of its elements.
static java.util.List<java.lang.Integer>	readDeleteContentsFile(java.io.File f)
static void	writeDocument(org.w3c.dom.Document doc, javax.xml.transform.Transformer transformer, java.io.OutputStream out) write xml document to output stream
static org.w3c.dom.Document	writeDublinCore(javax.xml.parsers.DocumentBuilder docBuilder, java.util.List<org.dspace.app.itemupdate.DtoMetadata> dtomList) Write dublin_core.xml

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataUtilities

public MetadataUtilities()

Method Detail

deleteMetadataByValue

public static boolean deleteMetadataByValue(Item item,
                            org.dspace.app.itemupdate.DtoMetadata dtom,
                            boolean isLanguageStrict)

Working around Item API to delete a value-specific DCValue For a given element/qualifier/lang: get all DCValues clear (i.e. delete) all of these DCValues add them back, minus the one to actually delete

Parameters:

item -

dtom -

isLanguageStrict - -

Returns:

true if metadata field is found with matching value and was deleted

appendMetadata

public static void appendMetadata(Item item,
                  org.dspace.app.itemupdate.DtoMetadata dtom,
                  boolean isLanguageStrict,
                  java.lang.String textToAppend)
                           throws java.lang.IllegalArgumentException

Append text to value metadata field to item

Parameters:

item -

dtom -

isLanguageStrict -

textToAppend -

Throws:

java.lang.IllegalArgumentException - - When target metadata field is not found

loadDublinCore

public static java.util.List<org.dspace.app.itemupdate.DtoMetadata> loadDublinCore(javax.xml.parsers.DocumentBuilder docBuilder,
                                                                   java.io.InputStream is)
                                                                            throws java.sql.SQLException,
                                                                                   java.io.IOException,
                                                                                   javax.xml.parsers.ParserConfigurationException,
                                                                                   org.xml.sax.SAXException,
                                                                                   javax.xml.transform.TransformerException,
                                                                                   AuthorizeException

Modification of method from ItemImporter.loadDublinCore as a Factory method

Parameters:

docBuilder - -

is - - InputStream of dublin_core.xml

Returns:

list of DtoMetadata representing the metadata fields relating to an Item

Throws:

java.sql.SQLException

java.io.IOException

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

javax.xml.transform.TransformerException

AuthorizeException

writeDublinCore

public static org.w3c.dom.Document writeDublinCore(javax.xml.parsers.DocumentBuilder docBuilder,
                                   java.util.List<org.dspace.app.itemupdate.DtoMetadata> dtomList)
                                            throws javax.xml.parsers.ParserConfigurationException,
                                                   javax.xml.transform.TransformerConfigurationException,
                                                   javax.xml.transform.TransformerException

Write dublin_core.xml

Parameters:

docBuilder -

dtomList -

Returns:

xml document

Throws:

javax.xml.parsers.ParserConfigurationException

javax.xml.transform.TransformerConfigurationException

javax.xml.transform.TransformerException

writeDocument

public static void writeDocument(org.w3c.dom.Document doc,
                 javax.xml.transform.Transformer transformer,
                 java.io.OutputStream out)
                          throws java.io.IOException,
                                 javax.xml.transform.TransformerException

write xml document to output stream

Parameters:

doc -

transformer -

out -

Throws:

java.io.IOException

javax.xml.transform.TransformerException

readContentsFile

public static java.util.List<ContentsEntry> readContentsFile(java.io.File f)
                                                      throws java.io.FileNotFoundException,
                                                             java.io.IOException,
                                                             java.text.ParseException

Rewrite of ItemImport's functionality but just the parsing of the file, not the processing of its elements.

Throws:

java.io.FileNotFoundException

java.io.IOException

java.text.ParseException

readDeleteContentsFile

public static java.util.List<java.lang.Integer> readDeleteContentsFile(java.io.File f)
                                                                throws java.io.FileNotFoundException,
                                                                       java.io.IOException

Parameters:

f -

Throws:

java.io.FileNotFoundException

java.io.IOException

getDCValueString

public static java.lang.String getDCValueString(DCValue dcv)

Get display of DCValue

Parameters:

dcv -

Returns:

string displaying elements of the DCValue

getCompoundForm

public static java.lang.String getCompoundForm(java.lang.String schema,
                               java.lang.String element,
                               java.lang.String qualifier)

Returns:

a String representation of the two- or three-part form of a metadata element e.g. dc.identifier.uri

parseCompoundForm

public static java.lang.String[] parseCompoundForm(java.lang.String compoundForm)
                                            throws java.text.ParseException

Parses metadata field given in the form .[.|.*] checks for correct number of elements (2 or 3) and for empty strings

Returns:

String Array

Throws:

java.text.ParseException - if validity checks fail