io.scif

Interface MetadataService

All Superinterfaces:

Comparable<org.scijava.Prioritized>, org.scijava.Contextual, org.scijava.Disposable, org.scijava.plugin.HasPluginInfo, org.scijava.Identifiable, org.scijava.Initializable, org.scijava.Locatable, org.scijava.log.Logged, org.scijava.Prioritized, org.scijava.plugin.RichPlugin, SCIFIOService, org.scijava.plugin.SciJavaPlugin, org.scijava.service.Service, org.scijava.Versioned

All Known Implementing Classes:

DefaultMetadataService

public interface MetadataService
extends SCIFIOService

Interface for services that work with SCIFIO metadata.

Author:

Curtis Rueden

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME_KEY

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	parse(String data) Parses key/value pairs from the given string, using the default separator regex of "[&\n]" (i.e., ampersand or newline).
Map<String,Object>	parse(String data, String regex) Parses key/value pairs from the given string, using the specified separator regex.
void	populate(Object metadata, Map<String,Object> map) Populates fields of the given metadata object with information from the given map.

Methods inherited from interface org.scijava.service.Service

initialize, registerEventHandlers

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Versioned

getVersion

Methods inherited from interface org.scijava.Disposable

dispose

Field Detail

NAME_KEY

static final String NAME_KEY

See Also:

Constant Field Values

Method Detail

parse

Map<String,Object> parse(String data)

Parses key/value pairs from the given string, using the default separator regex of "[&\n]" (i.e., ampersand or newline). Each key/value pair is assumed to be separated with an equals sign character ('='). The value can also be a list of values if each value is separated by a comma character (',').

parse

Map<String,Object> parse(String data,
                         String regex)

Parses key/value pairs from the given string, using the specified separator regex. Each key/value pair is assumed to be separated with an equals sign character ('='). The value can also be a list of values if each value is separated by a comma character (',').

See Also:

String.split(String)

populate

void populate(Object metadata,
              Map<String,Object> map)

Populates fields of the given metadata object with information from the given map. The metadata object can be any Java type (though it will typically be a SCIFIO Metadata object), but its instance fields must be marked with the @Field annotation.

Parameters:

metadata - The metadata object with annotated fields to populate.

map - The map defining the values to use when populating the metadata.