generated.docs.javadoc.org.eclipse.dawnsci.nexus.builder.NexusMetadataProvider.html Maven / Gradle / Ivy
NexusMetadataProvider (h5jan API)
org.eclipse.dawnsci.nexus.builder
Interface NexusMetadataProvider
-
- All Superinterfaces:
- NexusEntryModification
- All Known Implementing Classes:
- MapBasedMetadataProvider
public interface NexusMetadataProvider
extends NexusEntryModification
An interface defining a provider of metadata to a nexus entry (NXentry node),
or if getCategory() does not return null, then to the object (i.e. group node)
within the tree of that type.
When added to a nexus entry using NexusEntryBuilder.addMetadata(NexusMetadataProvider)
a field is added for each NexusMetadataProvider.MetadataEntry returned by the
getMetadataEntries() iterator.
-
-
Nested Class Summary
Nested Classes
Modifier and Type
Interface and Description
static interface NexusMetadataProvider.MetadataEntry
A metadata entry, describing the field to add to the
nexus entry or other node.
-
Method Summary
All Methods Instance Methods Abstract Methods
Modifier and Type
Method and Description
NexusBaseClassgetCategory()
Returns the category of this metadata provider.
java.util.Iterator<NexusMetadataProvider.MetadataEntry>getMetadataEntries()
Returns an iterator over the metadata entries.
-
-
Method Detail
-
getMetadataEntries
java.util.Iterator<NexusMetadataProvider.MetadataEntry> getMetadataEntries()
Returns an iterator over the metadata entries.
- Returns:
- iterator over metadata entries
-
getCategory
NexusBaseClass getCategory()
Returns the category of this metadata provider. If this method does not
return null, then fields will be added to the
nexus object (i.e. group node) in the tree with this type instead
of the NXentry for each root node.
- Returns:
- category category, a member of the
NexusBaseClass
enumeration of Nexus base class types.