it.geosolutions.imageio.maskband
Class DefaultDatasetLayoutImpl

Object
  extended by DefaultDatasetLayoutImpl
All Implemented Interfaces:
DatasetLayout

public class DefaultDatasetLayoutImpl
extends Object
implements DatasetLayout

Default implementation for DatasetLayout interface setting default values for interface methods.

Author:
Nicola Lagomarsini GeoSolutions S.A.S.

Constructor Summary
DefaultDatasetLayoutImpl()
           
 
Method Summary
 File getExternalMaskOverviews()
          This methods returns a File containing external overviews associated to external Image masks, or null if not present.
 File getExternalMasks()
          This methods returns a File containing external masks associated to input Image, or null if not present.
 File getExternalOverviews()
          This methods returns a File containing external overviews associated to input Image, or null if not present.
 int getInternalMaskImageIndex(int maskIndex)
          Returns the Mask index associated to the input image index defined.
 int getInternalOverviewImageIndex(int overviewIndex)
          Returns the Overview index associated to the input image index defined.
 int getNumExternalMaskOverviews()
          Returns the number of external mask overviews
 int getNumExternalMasks()
          Returns the total number of externals Image masks.
 int getNumExternalOverviews()
          Returns the number of external Image overviews
 int getNumInternalMasks()
          Returns the total number of internal Image masks.
 int getNumInternalOverviews()
          Returns the number of internal Image overviews
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultDatasetLayoutImpl

public DefaultDatasetLayoutImpl()
Method Detail

getNumInternalOverviews

public int getNumInternalOverviews()
Description copied from interface: DatasetLayout
Returns the number of internal Image overviews

Specified by:
getNumInternalOverviews in interface DatasetLayout
Returns:
an Integer indicating how many overviews are present

getNumExternalOverviews

public int getNumExternalOverviews()
Description copied from interface: DatasetLayout
Returns the number of external Image overviews

Specified by:
getNumExternalOverviews in interface DatasetLayout
Returns:
an Integer indicating how many overviews are present

getNumExternalMaskOverviews

public int getNumExternalMaskOverviews()
Description copied from interface: DatasetLayout
Returns the number of external mask overviews

Specified by:
getNumExternalMaskOverviews in interface DatasetLayout
Returns:
an Integer indicating how many overviews are present

getNumInternalMasks

public int getNumInternalMasks()
Description copied from interface: DatasetLayout
Returns the total number of internal Image masks. Notice that If masks are more than one, the others are considered as overviews of the first mask

Specified by:
getNumInternalMasks in interface DatasetLayout
Returns:
an Integer indicating how many masks are present

getNumExternalMasks

public int getNumExternalMasks()
Description copied from interface: DatasetLayout
Returns the total number of externals Image masks. Notice that If masks are more than one, the others are considered as overviews of the first mask

Specified by:
getNumExternalMasks in interface DatasetLayout
Returns:
an Integer indicating how many external masks are present

getInternalOverviewImageIndex

public int getInternalOverviewImageIndex(int overviewIndex)
Description copied from interface: DatasetLayout
Returns the Overview index associated to the input image index defined. This is helpful when we have overviews and masks and we are unable to distinguish them. If no overwiew is present or the overview index is greater than the maximum index, -1 will be returned.

Specified by:
getInternalOverviewImageIndex in interface DatasetLayout
Parameters:
overviewIndex - Integer defining an image overview index (0 means the native image)
Returns:
The Overview index related to the imageIndex defined

getInternalMaskImageIndex

public int getInternalMaskImageIndex(int maskIndex)
Description copied from interface: DatasetLayout
Returns the Mask index associated to the input image index defined. This is helpful when we have overviews and masks and we are unable to distinguish them. If no mask is present or the mask index is greater than the maximum index, -1 will be returned.

Specified by:
getInternalMaskImageIndex in interface DatasetLayout
Parameters:
maskIndex - Integer defining an image mask index (0 means the native image resolution)
Returns:
The Overview index related to the imageIndex defined

getExternalMasks

public File getExternalMasks()
Description copied from interface: DatasetLayout
This methods returns a File containing external masks associated to input Image, or null if not present.

Specified by:
getExternalMasks in interface DatasetLayout
Returns:
a File containing external masks associated to an input File

getExternalOverviews

public File getExternalOverviews()
Description copied from interface: DatasetLayout
This methods returns a File containing external overviews associated to input Image, or null if not present.

Specified by:
getExternalOverviews in interface DatasetLayout
Returns:
a File containing external overviews associated to an input File

getExternalMaskOverviews

public File getExternalMaskOverviews()
Description copied from interface: DatasetLayout
This methods returns a File containing external overviews associated to external Image masks, or null if not present.

Specified by:
getExternalMaskOverviews in interface DatasetLayout
Returns:
a File containing external mask overviews associated to an input File


Copyright © 2006–2018 GeoSolutions. All rights reserved.