edu.unh.sdb.common

Class Metadata

java.lang.Object

edu.unh.sdb.common.Metadata

All Implemented Interfaces:

java.lang.Cloneable

public class Metadata
extends java.lang.Object
implements java.lang.Cloneable

The Metadata class can be used to hold metadata information as {key, value} pairs, which are stored in a hashmap (an instance of the Properties class). The Metadata class also contains a 'name' field which can be thought of as an ID to help distinguish differen Metadata objects.

Constructor Summary

Constructors

Constructor and Description
Metadata() Default constructor.
Metadata(Metadata m) creates this object as a copy of the argument.
Metadata(java.lang.String name) Creates a new Metadata object with the given name.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clears this Metadata object of all properties.
Metadata	clone()
boolean	containsKey(java.lang.String key) Returns true if contains a property for the given key.
java.lang.String	getName() returns the name of this Metadata object.
java.lang.String	getProperty(java.lang.String key) Returns the property value associated with the key.
java.util.Iterator<java.lang.String>	iterator() Returns an Iterator over all the properties names.
void	load(java.io.InputStream inStream)
void	load(java.io.Reader reader)
void	load(java.lang.String str) Creates a StringReader and uses the load(Reader) method.
void	merge(Metadata m) adds all the key/values in the argument to this Metadata object.
java.util.Set<java.lang.String>	propertyNames() Returns a Set of all the property names in this object.
java.lang.String	remove(java.lang.String key) Removes the property associated with the given key.
void	setName(java.lang.String name) Sets the name of this Metadata object.
java.lang.String	setProperty(java.lang.String key, java.lang.String value) Sets the property with given key to the given value.
java.lang.String	toString()
java.lang.String	toXML(java.lang.String indent) returns a String representation of this Metadata object in XML form.

Methods inherited from class java.lang.Object

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

Constructor Detail

Metadata

public Metadata()

Default constructor. Constructs an empty Metadata object with a null String for a name.

Metadata

public Metadata(java.lang.String name)

Creates a new Metadata object with the given name.

Parameters:

name - the Metadata object's name.

Metadata

public Metadata(Metadata m)

creates this object as a copy of the argument.

Parameters:

m - the Metadata to copy.

Method Detail

clone

public Metadata clone()

Overrides:

clone in class java.lang.Object

merge

public void merge(Metadata m)

adds all the key/values in the argument to this Metadata object. If any of the keys are the same, use the argument's values. TODO: should it overwrite similar keys? TODO: what if they have different names? (the Metadata objects)

Parameters:

m - the Metadata to merge with.

setName

public void setName(java.lang.String name)

Sets the name of this Metadata object. NOTE: if you are using this Metadata object as part of a MetadataCollection, changing the name here will not update the key that this Metadata object is stored under in the MetadataCollection.

Parameters:

name - the name to set.

getName

public java.lang.String getName()

returns the name of this Metadata object.

Returns:

returns the name of this Metadata object.

toXML

public java.lang.String toXML(java.lang.String indent)

returns a String representation of this Metadata object in XML form.

Returns:

returns a String representation of this Metadata object in XML form.

load

public void load(java.io.Reader reader)
          throws java.io.IOException

Throws:

java.io.IOException

See Also:

Properties#load(Reader)}

load

public void load(java.io.InputStream inStream)
          throws java.io.IOException

Throws:

java.io.IOException

See Also:

Properties#load(InputStream)}

load

public void load(java.lang.String str)
          throws java.io.IOException

Creates a StringReader and uses the load(Reader) method.

Throws:

java.io.IOException

See Also:

Properties#load(Reader)}

propertyNames

public java.util.Set<java.lang.String> propertyNames()

Returns a Set of all the property names in this object.

Returns:

Returns a Set of all the property names in this object.

iterator

public java.util.Iterator<java.lang.String> iterator()

Returns an Iterator over all the properties names.

Returns:

Returns an Iterator over all the properties names.

getProperty

public java.lang.String getProperty(java.lang.String key)

Returns the property value associated with the key.

Parameters:

key - the property name.

Returns:

Returns the property value associated with the key or null if the key isn't present.

setProperty

public java.lang.String setProperty(java.lang.String key,
                           java.lang.String value)

Sets the property with given key to the given value.

Parameters:

key - the property's name.

value - the property's value.

Returns:

the previous value of the specified key, or null if it did not have one.

containsKey

public boolean containsKey(java.lang.String key)

Returns true if contains a property for the given key.

Parameters:

key - the key to search for.

Returns:

Returns true if contains a property for the given key.

clear

public void clear()

Clears this Metadata object of all properties. The name is unchanged.

remove

public java.lang.String remove(java.lang.String key)

Removes the property associated with the given key.

Parameters:

key - the key to remove.

Returns:

the value to which the key had been mapped to, or null if the key did not have a mapping.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object