MetadataCollection

java.lang.Object
- edu.unh.sdb.common.MetadataCollection

All Implemented Interfaces:

java.lang.Cloneable
```
public class MetadataCollection
extends java.lang.Object
implements java.lang.Cloneable
```
A MetaCollection is a HashMap of Metadata objects, where the name attribute of each Metadata object is the key and the Metadata object itself is the value. NOTE: global metadata (metadata not given a name attribute when defined) can be accessed by supplying a null string as the name using the 'getMetadata' method.

Constructor Summary

Constructors
Constructor and Description
`MetadataCollection()` Constructs an empty MetadataCollection.
`MetadataCollection(Metadata[] metadata)` Constructs a MetadataCollection from an array of Metadata objects.

Method Summary

Methods
Modifier and Type	Method and Description
`MetadataCollection`	`clone()`
`boolean`	`contains(java.lang.String name)` Returns true if this collection contains a Metadata object with the given name.
`Metadata`	`getMetadata(java.lang.String name)` Returns the Metadata object with the given name or null if it does not exist.
`java.util.Set<java.lang.String>`	`getNames()` Returns a Set containing all the keys (names) contained in this collection.
`java.util.Iterator<Metadata>`	`iterator()` Returns an iterator over the Metadata objects in this collection
`void`	`merge(MetadataCollection m)` Calls the 'update' method for each Metadata object in the given MetadataCollection.
`Metadata`	`removeMetadata(java.lang.String name)` Removes the Metadata object with the given name from the collection.
`Metadata`	`setMetadata(Metadata m)` Adds the specified Metadata object to this collection, using its name as the hashmap key.
`java.lang.String`	`toString()`
`java.lang.String`	`toXML(java.lang.String indent)` returns a String representing this metadata collection in XML format.
`void`	`update(Metadata m)` If the collection does not already contain a Metadata object with the same name as argument, then the argument is added to the collection.

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

- Constructor Detail
  - MetadataCollection
```
public MetadataCollection()
```
    Constructs an empty MetadataCollection.
  - MetadataCollection
```
public MetadataCollection(Metadata[] metadata)
```
    Constructs a MetadataCollection from an array of Metadata objects.
    
    Parameters:
    metadata - the Metadata array.
- Method Detail
  - clone
```
public MetadataCollection clone()
```
    Overrides:
    
    clone in class java.lang.Object
  - contains
```
public boolean contains(java.lang.String name)
```
    Returns true if this collection contains a Metadata object with the given name.
    
    Parameters:
    name - the name to search for.
    
    Returns:
    returns true if this collection contains a Metadata object with the given name.
  - getMetadata
```
public Metadata getMetadata(java.lang.String name)
```
    Returns the Metadata object with the given name or null if it does not exist.
    
    Parameters:
    name - the Metadata name to search for
    
    Returns:
    returns the Metadata object with the given name or null if it does not exist.
  - removeMetadata
```
public Metadata removeMetadata(java.lang.String name)
```
    Removes the Metadata object with the given name from the collection.
    
    Parameters:
    name - the name of the Metadata object to remove.
    
    Returns:
    Removes the Metadata object with the given name from the collection.
  - setMetadata
```
public Metadata setMetadata(Metadata m)
```
    Adds the specified Metadata object to this collection, using its name as the hashmap key. If there was already an entry under this key, it will be replaced.
    
    Parameters:
    m - the Metadata to set
    
    Returns:
    the previous value associated with the key, or null if there was no mapping for key.
  - update
```
public void update(Metadata m)
```
    If the collection does not already contain a Metadata object with the same name as argument, then the argument is added to the collection. If an entry with the same name already exists, then the existing Metadata object is merged with this one using the method 'merge' in the class Metadata.
    
    Parameters:
    m - the Metadata object to update.
  - merge
```
public void merge(MetadataCollection m)
```
    Calls the 'update' method for each Metadata object in the given MetadataCollection. Update will add Metadata objects that are new, or merge with entries that already exist.
    
    Parameters:
    m - the MetadataCollection to merge with.
  - iterator
```
public java.util.Iterator<Metadata> iterator()
```
    Returns an iterator over the Metadata objects in this collection
    
    Returns:
    Returns an iterator over the Metadata objects in this collection
  - getNames
```
public java.util.Set<java.lang.String> getNames()
```
    Returns a Set containing all the keys (names) contained in this collection.
    
    Returns:
    returns a Set containing all the keys (names) contained in this collection.
  - toXML
```
public java.lang.String toXML(java.lang.String indent)
```
    returns a String representing this metadata collection in XML format.
    
    Returns:
    returns a String representing this metadata collection in XML format.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class MetadataCollection

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MetadataCollection

MetadataCollection

Method Detail

clone

contains

getMetadata

removeMetadata

setMetadata

update

merge

iterator

getNames

toXML

toString