java.lang.Object
- it.geosolutions.geoserver.rest.encoder.utils.XmlElement
- - it.geosolutions.geoserver.rest.encoder.utils.PropertyXMLEncoder
  - - it.geosolutions.geoserver.rest.encoder.GSResourceEncoder
    - - it.geosolutions.geoserver.rest.encoder.coverage.GSCoverageEncoder
      - it.geosolutions.geoserver.rest.encoder.coverage.GSImageMosaicEncoder

```
public class GSImageMosaicEncoder
extends GSCoverageEncoder
```
Use this encoder for ImageMosaic coverages.

Version:

$Id: $

Author:

Carlo Cancellieri - carlo.cancellieri@geo-solutions.it, Simone Giannecchini, GeoSolutions SAS

Nested Class Summary
- Nested classes/interfaces inherited from class it.geosolutions.geoserver.rest.encoder.GSResourceEncoder
  GSResourceEncoder.ProjectionPolicy

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`allowMultithreading`	Constant `allowMultithreading="AllowMultithreading"`
`static java.lang.String`	`backgroundValues`	Constant `backgroundValues="BackgroundValues"`
`static java.lang.String`	`filter`	Constant `filter="Filter"`
`static java.lang.String`	`inputTransparentColor`	Constant `inputTransparentColor="InputTransparentColor"`
`static java.lang.String`	`maxAllowedTiles`	Constant `maxAllowedTiles="MaxAllowedTiles"`
`static java.lang.String`	`MERGEBEHAVIOR`	Constant `MERGEBEHAVIOR="MergeBehavior"`
`static java.lang.String`	`outputTransparentColor`	Constant `outputTransparentColor="OutputTransparentColor"`
`static java.lang.String`	`SORTING`	Constant `SORTING="SORTING"`
`static java.lang.String`	`SUGGESTED_TILE_SIZE`	Constant `SUGGESTED_TILE_SIZE="SUGGESTED_TILE_SIZE"`
`static java.lang.String`	`USE_JAI_IMAGEREAD`	Constant `USE_JAI_IMAGEREAD="USE_JAI_IMAGEREAD"`

Fields inherited from class it.geosolutions.geoserver.rest.encoder.coverage.GSCoverageEncoder
DIMENSIONS, NATIVECOVERAGENAME

Fields inherited from class it.geosolutions.geoserver.rest.encoder.GSResourceEncoder
KEYWORDS, METADATA, METADATALINKS, NAME, NATIVENAME

Constructor Summary

Constructors
Constructor Description

GSImageMosaicEncoder()
Constructor for GSImageMosaicEncoder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`addAllowMultithreading(boolean val)`	addAllowMultithreading
`protected void`	`addBackgroundValues(java.lang.String val)`	addBackgroundValues
`protected void`	`addFilter(java.lang.String val)`	addFilter
`protected void`	`addInputTransparentColor(java.lang.String val)`	addInputTransparentColor
`protected void`	`addMaxAllowedTiles(int val)`	addMaxAllowedTiles
`protected void`	`addMergeBehavior(java.lang.String val)`	addMergeBehavior
`protected void`	`addOutputTransparentColor(java.lang.String val)`	addOutputTransparentColor
`protected void`	`addSORTING(java.lang.String val)`	addSORTING
`protected void`	`addSUGGESTED_TILE_SIZE(java.lang.String val)`	addSUGGESTED_TILE_SIZE
`protected void`	`addUSE_JAI_IMAGEREAD(boolean val)`	addUSE_JAI_IMAGEREAD
`java.lang.Boolean`	`getAllowMultithreading()`	Getter for the field `allowMultithreading`.
`java.lang.Boolean`	`getBackgroundValues()`	Getter for the field `backgroundValues`.
`java.lang.Boolean`	`getFilter()`	Getter for the field `filter`.
`java.lang.Boolean`	`getInputTransparentColor()`	Getter for the field `inputTransparentColor`.
`java.lang.Boolean`	`getMaxAllowedTiles()`	Getter for the field `maxAllowedTiles`.
`java.lang.Boolean`	`getOutputTransparentColor()`	Getter for the field `outputTransparentColor`.
`java.lang.String`	`getSuggestedTileSize()`	getSuggestedTileSize
`java.lang.Boolean`	`getUseJaiImageRead()`	getUseJaiImageRead
`void`	`setAllowMultithreading(boolean val)`	Setter for the field `allowMultithreading`.
`void`	`setBackgroundValues(java.lang.String val)`	Setter for the field `backgroundValues`.
`void`	`setFilter(java.lang.String val)`	Setter for the field `filter`.
`void`	`setInputTransparentColor(java.lang.String val)`	Setter for the field `inputTransparentColor`.
`void`	`setMaxAllowedTiles(int val)`	Setter for the field `maxAllowedTiles`.
`void`	`setMergeBehavior(java.lang.String val)`	setMergeBehavior
`void`	`setOutputTransparentColor(java.lang.String val)`	Setter for the field `outputTransparentColor`.
`void`	`setSORTING(java.lang.String val)`	setSORTING
`void`	`setSUGGESTED_TILE_SIZE(java.lang.String val)`	setSUGGESTED_TILE_SIZE
`void`	`setUSE_JAI_IMAGEREAD(boolean val)`	setUSE_JAI_IMAGEREAD

Methods inherited from class it.geosolutions.geoserver.rest.encoder.coverage.GSCoverageEncoder
addCoverageDimensionInfo, addCoverageDimensionInfo, addMetadata, addNativeCoverageName, addSupportedFormats, delCoverageDimensionInfo, getNativeCoverageName, setMetadata, setNativeCoverageName, setNativeFormat, setRequestSRS, setResponseSRS

Methods inherited from class it.geosolutions.geoserver.rest.encoder.GSResourceEncoder
addAbstract, addDescription, addKeyword, addKeyword, addLatLonBoundingBox, addMetadata, addMetadata, addMetadataDimension, addMetadataDimension, addMetadataLinkInfo, addMetadataLinkInfo, addMetadataString, addName, addNativeBoundingBox, addNativeCRS, addNativeName, addProjectionPolicy, addSRS, addTitle, delKeyword, delKeyword, delMetadata, delMetadataLinkInfo, getName, getNativeName, setAbstract, setAdvertised, setDescription, setEnabled, setLatLonBoundingBox, setMetadata, setMetadataDimension, setMetadataDimension, setMetadataString, setName, setNativeBoundingBox, setNativeCRS, setNativeName, setProjectionPolicy, setSRS, setTitle

Methods inherited from class it.geosolutions.geoserver.rest.encoder.utils.PropertyXMLEncoder
add, get, get, set

Methods inherited from class it.geosolutions.geoserver.rest.encoder.utils.XmlElement
add, addContent, getRoot, isEmpty, remove, set, setRoot, setRoot, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - allowMultithreading
```
public static final java.lang.String allowMultithreading
```
    Constant allowMultithreading="AllowMultithreading"
    
    See Also:
    
    Constant Field Values
  - filter
```
public static final java.lang.String filter
```
    Constant filter="Filter"
    
    See Also:
    
    Constant Field Values
  - maxAllowedTiles
```
public static final java.lang.String maxAllowedTiles
```
    Constant maxAllowedTiles="MaxAllowedTiles"
    
    See Also:
    
    Constant Field Values
  - inputTransparentColor
```
public static final java.lang.String inputTransparentColor
```
    Constant inputTransparentColor="InputTransparentColor"
    
    See Also:
    
    Constant Field Values
  - outputTransparentColor
```
public static final java.lang.String outputTransparentColor
```
    Constant outputTransparentColor="OutputTransparentColor"
    
    See Also:
    
    Constant Field Values
  - SUGGESTED_TILE_SIZE
```
public static final java.lang.String SUGGESTED_TILE_SIZE
```
    Constant SUGGESTED_TILE_SIZE="SUGGESTED_TILE_SIZE"
    
    See Also:
    
    Constant Field Values
  - USE_JAI_IMAGEREAD
```
public static final java.lang.String USE_JAI_IMAGEREAD
```
    Constant USE_JAI_IMAGEREAD="USE_JAI_IMAGEREAD"
    
    See Also:
    
    Constant Field Values
  - backgroundValues
```
public static final java.lang.String backgroundValues
```
    Constant backgroundValues="BackgroundValues"
    
    See Also:
    
    Constant Field Values
  - SORTING
```
public static final java.lang.String SORTING
```
    Constant SORTING="SORTING"
    
    See Also:
    
    Constant Field Values
  - MERGEBEHAVIOR
```
public static final java.lang.String MERGEBEHAVIOR
```
    Constant MERGEBEHAVIOR="MergeBehavior"
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GSImageMosaicEncoder
```
public GSImageMosaicEncoder()
```
    Constructor for GSImageMosaicEncoder.
- Method Detail
  - addAllowMultithreading
```
protected void addAllowMultithreading(boolean val)
```
    addAllowMultithreading
    
    Parameters:
    
    val - a boolean.
  - setAllowMultithreading
```
public void setAllowMultithreading(boolean val)
```
    Setter for the field allowMultithreading.
    
    Parameters:
    
    val - a boolean.
  - getAllowMultithreading
```
public java.lang.Boolean getAllowMultithreading()
```
    Getter for the field allowMultithreading.
    
    Returns:
    
    a Boolean object.
  - addFilter
```
protected void addFilter(java.lang.String val)
```
    addFilter
    
    Parameters:
    
    val - a String object.
  - setFilter
```
public void setFilter(java.lang.String val)
```
    Setter for the field filter.
    
    Parameters:
    
    val - a String object.
  - getFilter
```
public java.lang.Boolean getFilter()
```
    Getter for the field filter.
    
    Returns:
    
    a Boolean object.
  - addMaxAllowedTiles
```
protected void addMaxAllowedTiles(int val)
```
    addMaxAllowedTiles
    
    Parameters:
    
    val - a int.
  - setMaxAllowedTiles
```
public void setMaxAllowedTiles(int val)
```
    Setter for the field maxAllowedTiles.
    
    Parameters:
    
    val - a int.
  - getMaxAllowedTiles
```
public java.lang.Boolean getMaxAllowedTiles()
```
    Getter for the field maxAllowedTiles.
    
    Returns:
    
    a Boolean object.
  - addInputTransparentColor
```
protected void addInputTransparentColor(java.lang.String val)
```
    addInputTransparentColor
    
    Parameters:
    
    val - a String object.
  - setInputTransparentColor
```
public void setInputTransparentColor(java.lang.String val)
```
    Setter for the field inputTransparentColor.
    
    Parameters:
    
    val - a String object.
  - getInputTransparentColor
```
public java.lang.Boolean getInputTransparentColor()
```
    Getter for the field inputTransparentColor.
    
    Returns:
    
    a Boolean object.
  - addOutputTransparentColor
```
protected void addOutputTransparentColor(java.lang.String val)
```
    addOutputTransparentColor
    
    Parameters:
    
    val - a String object.
  - setOutputTransparentColor
```
public void setOutputTransparentColor(java.lang.String val)
```
    Setter for the field outputTransparentColor.
    
    Parameters:
    
    val - a String object.
  - getOutputTransparentColor
```
public java.lang.Boolean getOutputTransparentColor()
```
    Getter for the field outputTransparentColor.
    
    Returns:
    
    a Boolean object.
  - addSUGGESTED_TILE_SIZE
```
protected void addSUGGESTED_TILE_SIZE(java.lang.String val)
```
    addSUGGESTED_TILE_SIZE
    
    Parameters:
    
    val - a String object.
  - setSUGGESTED_TILE_SIZE
```
public void setSUGGESTED_TILE_SIZE(java.lang.String val)
```
    setSUGGESTED_TILE_SIZE
    
    Parameters:
    
    val - a String object.
  - getSuggestedTileSize
```
public java.lang.String getSuggestedTileSize()
```
    getSuggestedTileSize
    
    Returns:
    
    a String object.
  - addUSE_JAI_IMAGEREAD
```
protected void addUSE_JAI_IMAGEREAD(boolean val)
```
    addUSE_JAI_IMAGEREAD
    
    Parameters:
    
    val - a boolean.
  - setUSE_JAI_IMAGEREAD
```
public void setUSE_JAI_IMAGEREAD(boolean val)
```
    setUSE_JAI_IMAGEREAD
    
    Parameters:
    
    val - a boolean.
  - getUseJaiImageRead
```
public java.lang.Boolean getUseJaiImageRead()
```
    getUseJaiImageRead
    
    Returns:
    
    a Boolean object.
  - addBackgroundValues
```
protected void addBackgroundValues(java.lang.String val)
```
    addBackgroundValues
    
    Parameters:
    
    val - a String object.
  - setBackgroundValues
```
public void setBackgroundValues(java.lang.String val)
```
    Setter for the field backgroundValues.
    
    Parameters:
    
    val - a String object.
  - getBackgroundValues
```
public java.lang.Boolean getBackgroundValues()
```
    Getter for the field backgroundValues.
    
    Returns:
    
    a Boolean object.
  - addSORTING
```
protected void addSORTING(java.lang.String val)
```
    addSORTING
    
    Parameters:
    
    val - a String object.
  - setSORTING
```
public void setSORTING(java.lang.String val)
```
    setSORTING
    
    Parameters:
    
    val - a String object.
  - addMergeBehavior
```
protected void addMergeBehavior(java.lang.String val)
```
    addMergeBehavior
    
    Parameters:
    
    val - a String object.
  - setMergeBehavior
```
public void setMergeBehavior(java.lang.String val)
```
    setMergeBehavior
    
    Parameters:
    
    val - a String object.

Class GSImageMosaicEncoder

Nested Class Summary

Nested classes/interfaces inherited from class it.geosolutions.geoserver.rest.encoder.GSResourceEncoder

Field Summary

Fields inherited from class it.geosolutions.geoserver.rest.encoder.coverage.GSCoverageEncoder

Fields inherited from class it.geosolutions.geoserver.rest.encoder.GSResourceEncoder

Constructor Summary

Method Summary

Methods inherited from class it.geosolutions.geoserver.rest.encoder.coverage.GSCoverageEncoder

Methods inherited from class it.geosolutions.geoserver.rest.encoder.GSResourceEncoder

Methods inherited from class it.geosolutions.geoserver.rest.encoder.utils.PropertyXMLEncoder

Methods inherited from class it.geosolutions.geoserver.rest.encoder.utils.XmlElement

Methods inherited from class java.lang.Object

Field Detail

allowMultithreading

filter

maxAllowedTiles

inputTransparentColor

outputTransparentColor

SUGGESTED_TILE_SIZE

USE_JAI_IMAGEREAD

backgroundValues

SORTING

MERGEBEHAVIOR

Constructor Detail

GSImageMosaicEncoder

Method Detail

addAllowMultithreading

setAllowMultithreading

getAllowMultithreading

addFilter

setFilter

getFilter

addMaxAllowedTiles

setMaxAllowedTiles

getMaxAllowedTiles

addInputTransparentColor

setInputTransparentColor

getInputTransparentColor

addOutputTransparentColor

setOutputTransparentColor

getOutputTransparentColor

addSUGGESTED_TILE_SIZE

setSUGGESTED_TILE_SIZE

getSuggestedTileSize

addUSE_JAI_IMAGEREAD

setUSE_JAI_IMAGEREAD

getUseJaiImageRead

addBackgroundValues

setBackgroundValues

getBackgroundValues

addSORTING

setSORTING

addMergeBehavior

setMergeBehavior