public interface IMetadata extends IDataAnalysisObject, MetadataType, Serializable
All returned collections and maps are unmodifiable.
Modifier and Type | Field and Description |
---|---|
static long |
serialVersionUID
Update this when there are any serious changes to API
|
Modifier and Type | Method and Description |
---|---|
void |
addDataInfo(String name,
int... shape)
Add name and shape of a dataset to metadata
|
void |
addNames(Collection<String> names) |
IMetadata |
clone()
Copy of metadata
|
Collection<String> |
getDataNames()
Returns a collection of dataset names or null if not implemented
|
Map<String,int[]> |
getDataShapes()
Can be implemented to return shapes of dataset
(shape can be null if it is not known)
|
Map<String,Integer> |
getDataSizes()
Can be implemented to return sizes of datasets
(size can be null if it is not known)
|
String |
getFilePath() |
Collection<String> |
getMetaNames()
Returns a collection of metadata names
|
Serializable |
getMetaValue(String key)
Returns string value or null if not implemented
|
Collection<Serializable> |
getUserObjects()
May be implemented to provide custom metadata in the form of a collection of serializable objects
|
void |
initialize(Map<String,? extends Serializable> metadata)
Initialize metadata
|
void |
setFilePath(String filename) |
void |
setMetadata(Map<String,? extends Serializable> metadata)
Set metadata map
|
static final long serialVersionUID
void initialize(Map<String,? extends Serializable> metadata)
metadata
- String getFilePath()
Collection<String> getDataNames()
Map<String,Integer> getDataSizes()
Map<String,int[]> getDataShapes()
Serializable getMetaValue(String key) throws MetadataException
key
- MetadataException
Collection<String> getMetaNames() throws MetadataException
MetadataException
Collection<Serializable> getUserObjects()
IMetadata clone()
clone
in interface IDataAnalysisObject
clone
in interface MetadataType
void setFilePath(String filename)
void addDataInfo(String name, int... shape)
name
- shape
- (can be null or zero-length)
(NOTE method should be public, people can define loaders outside this
package like the DESY FIO loader for instance.)void addNames(Collection<String> names)
void setMetadata(Map<String,? extends Serializable> metadata)
metadata
- Copyright © 2014–2019 Eclipse Foundation. All rights reserved.