/*
* #%L
* BSD implementations of Bio-Formats readers and writers
* %%
* Copyright (C) 2005 - 2015 Open Microscopy Environment:
* - Board of Regents of the University of Wisconsin-Madison
* - Glencoe Software, Inc.
* - University of Dundee
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
* #L%
*/
package loci.formats.cache;
import java.io.IOException;
import loci.formats.FileStitcher;
import loci.formats.FormatException;
import loci.formats.IFormatReader;
/**
* Superclass of cache sources that retrieve image planes
* from a data source (e.g., a file) using Bio-Formats.
*/
public abstract class CacheSource implements ICacheSource {
// -- Fields --
/** Reader from which to draw image planes. */
protected IFormatReader reader;
// -- Constructors --
/** Constructs a cache source from the given Bio-Formats reader. */
public CacheSource(IFormatReader r) { reader = r; }
/** Constructs a cache source that draws from the given file. */
public CacheSource(String id) throws CacheException {
this(new FileStitcher());
try { reader.setId(id); }
catch (FormatException exc) { throw new CacheException(exc); }
catch (IOException exc) { throw new CacheException(exc); }
}
// -- ICacheSource API methods --
/* @see loci.formats.cache.ICacheSource#getObjectCount() */
@Override
public int getObjectCount() { return reader.getImageCount(); }
/* @see ICacheSource#getObject(int) */
@Override
public abstract Object getObject(int index) throws CacheException;
}