MetaDataHolder (CombineArchive 1.4.1 API)

java.lang.Object
- de.unirostock.sems.cbarchive.meta.MetaDataHolder

Direct Known Subclasses:

ArchiveEntry, CombineArchive, MetaDataFile
```
public abstract class MetaDataHolder
extends Object
```
The Class MetaDataHolder representing objects that may contain meta data.

Author:

Martin Scharm

Field Summary

Fields
Modifier and Type Field Description

protected List<MetaDataObject> descriptions
The descriptions about the entity.

Constructor Summary

Constructors
Constructor Description

MetaDataHolder()
Instantiates a new MetaDataHolder.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addDescription(MetaDataObject description)`	Adds another meta object describing this entry.
`void`	`addDescription(String fragmentIdentifier, MetaDataObject description)`	Adds another meta object describing this entry.
`List<MetaDataObject>`	`getDescriptions()`	Gets the `MetaDataObjects` describing this entity.
`abstract String`	`getEntityPath()`	Gets the path to this entity.
`boolean`	`removeDescription(MetaDataObject toDelete)`	Removes a certain description of this entity.

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

- Field Detail
  - descriptions
```
protected List<MetaDataObject> descriptions
```
    The descriptions about the entity.
- Constructor Detail
  - MetaDataHolder
```
public MetaDataHolder()
```
    Instantiates a new MetaDataHolder.
- Method Detail
  - getEntityPath
```
public abstract String getEntityPath()
```
    Gets the path to this entity.
    
    Returns:
    
    the file path
  - getDescriptions
```
public List<MetaDataObject> getDescriptions()
```
    Gets the MetaDataObjects describing this entity.
    The returned list can contain any number of MetaDataObjects, but might as well be empty.
    
    Returns:
    
    the descriptions
  - removeDescription
```
public boolean removeDescription(MetaDataObject toDelete)
```
    Removes a certain description of this entity.
    
    Parameters:
    
    toDelete - the meta data object to delete
    
    Returns:
    
    true, if successful
  - addDescription
```
public void addDescription(String fragmentIdentifier,
                           MetaDataObject description)
```
    Adds another meta object describing this entry.
    
    Parameters:
    
    fragmentIdentifier - the fragment identifier pointing into this entry
    
    description - the new description
  - addDescription
```
public void addDescription(MetaDataObject description)
```
    Adds another meta object describing this entry.
    
    Parameters:
    
    description - the new description