io.scif

Class AbstractMetadata

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

io.scif.AbstractSCIFIOPlugin

io.scif.AbstractHasFormat

io.scif.AbstractHasSource

io.scif.AbstractMetadata

All Implemented Interfaces:

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

Direct Known Subclasses:

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

public abstract class AbstractMetadata
extends AbstractHasSource
implements TypedMetadata

Abstract superclass of all SCIFIO Metadata implementations.

Author:

Mark Hiner

See Also:

Metadata, Parser, HasFormat, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractMetadata()
AbstractMetadata(List<ImageMetadata> list)
AbstractMetadata(Metadata copy)

Method Summary

Modifier and Type	Method and Description
void	add(ImageMetadata meta) Adds the provided image metadata to this dataset metadata
void	close(boolean fileOnly) Closes the image source(s) associated with this component, with a toggle to determine if the component itself is reset.
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()
MetaTable	getTable()
boolean	isFiltered() Returns whether or not filterMetadata was set when parsing this Metadata object.
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> source) Sets the input source attached to this Metadata object.
void	setSourceLocation(org.scijava.io.location.Location loc) Sets the input source location.
void	setTable(MetaTable table) Sets the table for this component

Methods inherited from class io.scif.AbstractHasSource

close

Methods inherited from class io.scif.AbstractHasFormat

asBrowsableLocation, asBrowsableLocation, getFormat, getFormatName

Methods inherited from class io.scif.AbstractSCIFIOPlugin

getVersion, log

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

getInfo, getPriority, setInfo, setPriority, toString

Methods inherited from class org.scijava.AbstractContextual

context, getContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.scif.Metadata

populateImageMetadata

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

Constructor Detail

AbstractMetadata

public AbstractMetadata()

AbstractMetadata

public AbstractMetadata(Metadata copy)

AbstractMetadata

public AbstractMetadata(List<ImageMetadata> list)

Method Detail

setSource

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

Description copied from interface: Metadata

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

Specified by:

setSource in interface Metadata

Parameters:

source - - Input source for this Metadata

setSourceLocation

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

Description copied from interface: Metadata

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

Specified by:

setSourceLocation in interface Metadata

Parameters:

loc - the source location

getSourceLocation

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

Specified by:

getSourceLocation in interface Metadata

Returns:

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

getDestinationLocation

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

Specified by:

getDestinationLocation in interface Metadata

Returns:

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

setDestinationLocation

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

Description copied from interface: Metadata

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

Specified by:

setDestinationLocation in interface Metadata

Parameters:

loc - the destination location

getSource

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

Description copied from interface: Metadata

Returns the source used to generate this Metadata object.

Specified by:

getSource in interface Metadata

Returns:

- The associated RandomAccessInputStream

isFiltered

public boolean isFiltered()

Description copied from interface: Metadata

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

Specified by:

isFiltered in interface Metadata

Returns:

True if Metadata was filtered when parsing

getDatasetName

public String getDatasetName()

Description copied from interface: Metadata

Returns a String representation of this Dataset's name

Specified by:

getDatasetName in interface Metadata

get

public ImageMetadata get(int imageIndex)

Description copied from interface: Metadata

Returns the ImageMetadata at the specified image within this dataset.

Specified by:

get in interface Metadata

getAll

public List<ImageMetadata> getAll()

Description copied from interface: Metadata

Returns the list of ImageMetadata associated with this dataset.

Specified by:

getAll in interface Metadata

getImageCount

public int getImageCount()

Description copied from interface: Metadata

Returns the number of images in this dataset.

Specified by:

getImageCount in interface Metadata

getDatasetSize

public long getDatasetSize()

Description copied from interface: Metadata

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

Specified by:

getDatasetSize in interface Metadata

setDatasetName

public void setDatasetName(String name)

Description copied from interface: Metadata

Sets the name for this dataset.

Specified by:

setDatasetName in interface Metadata

Parameters:

name - - the dataset name

setFiltered

public void setFiltered(boolean filtered)

Description copied from interface: Metadata

Sets whether this metadata was filtered when parsed.

Specified by:

setFiltered in interface Metadata

add

public void add(ImageMetadata meta)

Description copied from interface: Metadata

Adds the provided image metadata to this dataset metadata

Specified by:

add in interface Metadata

createImageMetadata

public void createImageMetadata(int imageCount)

Description copied from interface: Metadata

Creates the specified number of blank ImageMetadata.

Specified by:

createImageMetadata in interface Metadata

Parameters:

imageCount - - Number of ImageMetadata to create.

getTable

public MetaTable getTable()

Specified by:

getTable in interface HasMetaTable

Returns:

the MetaTable attached to this component

setTable

public void setTable(MetaTable table)

Description copied from interface: HasMetaTable

Sets the table for this component

Specified by:

setTable in interface HasMetaTable

Parameters:

table - - a MetaTable implementation

close

public void close(boolean fileOnly)
           throws IOException

Description copied from interface: HasSource

Closes the image source(s) associated with this component, with a toggle to determine if the component itself is reset.

Specified by:

close in interface HasSource

Parameters:

fileOnly - - If true, only the associated source(s) are closed.

Throws:

IOException