io.scif

Interface Metadata

All Superinterfaces:

Comparable<org.scijava.Prioritized>, org.scijava.Contextual, HasFormat, HasMetaTable, org.scijava.plugin.HasPluginInfo, HasSource, org.scijava.Identifiable, org.scijava.Locatable, org.scijava.log.Logged, org.scijava.Prioritized, org.scijava.plugin.RichPlugin, SCIFIOPlugin, org.scijava.plugin.SciJavaPlugin, Serializable, org.scijava.Versioned

All Known Subinterfaces:

MetadataWrapper, TypedMetadata

All Known Implementing Classes:

AbstractMetadata, AbstractMetadataWrapper, APNGFormat.Metadata, AVIFormat.Metadata, BMPFormat.Metadata, ChannelFillerMetadata, DefaultMetadata, DICOMFormat.Metadata, DimensionSwapperMetadata, EPSFormat.Metadata, FileStitcherMetadata, FITSFormat.Metadata, GIFFormat.Metadata, ICSFormat.Metadata, ImageIOFormat.Metadata, JPEG2000Format.Metadata, JPEGFormat.Metadata, JPEGTileFormat.Metadata, KontronFormat.Metadata, LegacyQTFormat.Metadata, MicromanagerFormat.Metadata, MinimalTIFFFormat.Metadata, MNGFormat.Metadata, NativeQTFormat.Metadata, NRRDFormat.Metadata, PCXFormat.Metadata, PGMFormat.Metadata, PICTFormat.Metadata, PlaneSeparatorMetadata, ScancoISQFormat.Metadata, StratecPQCTFormat.Metadata, TestImgFormat.Metadata, TIFFFormat.Metadata, TIFFJAIFormat.Metadata

public interface Metadata
extends Serializable, HasFormat, HasSource, HasMetaTable

Interface for all SCIFIO Metadata objects. Based on the format, a Metadata object can be a single N-dimensional collection of bytes (an image) or a list of multiple images.

NB: When defining a new Metadata implementation, you will likely want to create a corresponding Format implementation. Also, at a minimum, a Translator should be implemented that can convert between Metadata and the new Metadata.

See Also:

Translator, AbstractFormat

Method Summary

Modifier and Type	Method and Description
void	add(ImageMetadata meta) Adds the provided image metadata to this dataset metadata
void	createImageMetadata(int imageCount) Creates the specified number of blank ImageMetadata.
ImageMetadata	get(int imageIndex) Returns the ImageMetadata at the specified image within this dataset.
List<ImageMetadata>	getAll() Returns the list of ImageMetadata associated with this dataset.
String	getDatasetName() Returns a String representation of this Dataset's name
long	getDatasetSize() Returns the size, in bytes, of the current dataset.
org.scijava.io.location.Location	getDestinationLocation()
int	getImageCount() Returns the number of images in this dataset.
org.scijava.io.handle.DataHandle<org.scijava.io.location.Location>	getSource() Returns the source used to generate this Metadata object.
org.scijava.io.location.Location	getSourceLocation()
boolean	isFiltered() Returns whether or not filterMetadata was set when parsing this Metadata object.
void	populateImageMetadata() Generates format-agnostic image metadata structures based on this instance's format-specific metadata.
void	setDatasetName(String name) Sets the name for this dataset.
void	setDestinationLocation(org.scijava.io.location.Location loc) Sets the output location.
void	setFiltered(boolean filtered) Sets whether this metadata was filtered when parsed.
void	setSource(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> in) Sets the input source attached to this Metadata object.
void	setSourceLocation(org.scijava.io.location.Location loc) Sets the input source location.

Methods inherited from interface io.scif.HasFormat

getFormat, getFormatName

Methods inherited from interface io.scif.SCIFIOPlugin

getVersion, log

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier

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 io.scif.HasSource

close, close

Methods inherited from interface io.scif.HasMetaTable

getTable, setTable

Method Detail

setSource

void setSource(org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> in)

Sets the input source attached to this Metadata object. Note that calling this method does not affect the structure of this Metadata object.

Parameters:

in - - Input source for this Metadata

getSource

org.scijava.io.handle.DataHandle<org.scijava.io.location.Location> getSource()

Returns the source used to generate this Metadata object.

Returns:

- The associated RandomAccessInputStream

setSourceLocation

void setSourceLocation(org.scijava.io.location.Location loc)

Sets the input source location. This is an alternative to setSource(DataHandle) for Formats that operate on Locations without a corresponding DataHandle.

Parameters:

loc - the source location

setDestinationLocation

void setDestinationLocation(org.scijava.io.location.Location loc)

Sets the output location. This is used by formats that do not use a DataHandle.

Parameters:

loc - the destination location

getDestinationLocation

org.scijava.io.location.Location getDestinationLocation()

Returns:

the destination location, this is used by formats that do not use a DataHandle.

getSourceLocation

org.scijava.io.location.Location getSourceLocation()

Returns:

the source location, in most cases this is equivalent to calling getSource().get()

isFiltered

boolean isFiltered()

Returns whether or not filterMetadata was set when parsing this Metadata object.

Returns:

True if Metadata was filtered when parsing

populateImageMetadata

void populateImageMetadata()

Generates format-agnostic image metadata structures based on this instance's format-specific metadata.

getDatasetName

String getDatasetName()

Returns a String representation of this Dataset's name

get

ImageMetadata get(int imageIndex)

Returns the ImageMetadata at the specified image within this dataset.

getAll

List<ImageMetadata> getAll()

Returns the list of ImageMetadata associated with this dataset.

getImageCount

int getImageCount()

Returns the number of images in this dataset.

getDatasetSize

long getDatasetSize()

Returns the size, in bytes, of the current dataset.

setDatasetName

void setDatasetName(String name)

Sets the name for this dataset.

Parameters:

name - - the dataset name

setFiltered

void setFiltered(boolean filtered)

Sets whether this metadata was filtered when parsed.

add

void add(ImageMetadata meta)

Adds the provided image metadata to this dataset metadata

createImageMetadata

void createImageMetadata(int imageCount)

Creates the specified number of blank ImageMetadata.

Parameters:

imageCount - - Number of ImageMetadata to create.