java.lang.Object
- com.esri.arcgisruntime.raster.MosaicRule

```
public final class MosaicRule
extends java.lang.Object
```
A rule determining how a requested image should participate in the mosaic.
An image service uses a mosaic rule to mosaic multiple rasters on-the-fly. A mosaic rule parameter is used by many image service operations, such as export image and identify operations. See also Understanding the mosaicking rules for a mosaic dataset

Since:

100.9.0

Constructor Summary

Constructors
Constructor Description

MosaicRule()
Creates a mosaic rule object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`RenderingRule`	`getItemRenderingRule()`	Gets the rendering rule applied on items before mosaic operation.
`java.util.List<java.lang.Long>`	`getLockRasterIds()`	Gets the collection of raster IDs for image service rasters forced to be visible at all scales.
`MosaicMethod`	`getMosaicMethod()`	Gets the type of mosaic method used for individual images.
`MosaicOperation`	`getMosaicOperation()`	Specifies the mosaic operation used to resolve overlapped pixel values.
`java.util.List<java.lang.Long>`	`getRasterIds()`	Gets the collection of raster IDs specifying a subset of rasters used in the mosaic.
`java.lang.String`	`getSortField()`	Gets the field name used together with `MosaicMethod.ATTRIBUTE`.
`java.lang.String`	`getSortValue()`	Gets the base sort value used together with `MosaicMethod.ATTRIBUTE` and `getSortField()`.
`Viewpoint`	`getViewpoint()`	Gets the viewpoint used along with `MosaicMethod.VIEWPOINT`.
`java.lang.String`	`getWhereClause()`	Gets the SQL WHERE clause to define a subset of rasters used in the mosaic.
`boolean`	`isAscending()`	Indicates whether this MosaicRule is ascending.
`void`	`setAscending(boolean isAscending)`	Sets whether this MosaicRule is ascending.
`void`	`setItemRenderingRule(RenderingRule itemRenderingRule)`	Sets the rendering rule applied on items before mosaic operation.
`void`	`setMosaicMethod(MosaicMethod mosaicMethod)`	Sets the type of mosaic method used for individual images.
`void`	`setMosaicOperation(MosaicOperation mosaicOperation)`	Specifies the mosaic operation used to resolve overlapped pixel values.
`void`	`setSortField(java.lang.String sortField)`	Sets the field name used together with `MosaicMethod.ATTRIBUTE`.
`void`	`setSortValue(java.lang.String sortValue)`	Sets the base sort value used together with `MosaicMethod.ATTRIBUTE` and `getSortField()`.
`void`	`setViewpoint(Viewpoint viewpoint)`	Sets the viewpoint used along with `MosaicMethod.VIEWPOINT`.
`void`	`setWhereClause(java.lang.String whereClause)`	Sets the SQL WHERE clause to define a subset of rasters used in the mosaic.

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

- Constructor Detail
  - MosaicRule
```
public MosaicRule()
```
    Creates a mosaic rule object.
    
    Since:
    
    100.9.0
- Method Detail
  - isAscending
```
public boolean isAscending()
```
    Indicates whether this MosaicRule is ascending. The default value is the value used when the mosaic data was created, if unavailable, the default value is true.
    
    Returns:
    
    true if this MosaicRule is ascending
    
    Since:
    
    100.9.0
  - setAscending
```
public void setAscending(boolean isAscending)
```
    Sets whether this MosaicRule is ascending.
    
    Parameters:
    
    isAscending - indicates whether this MosaicRule is ascending
    
    Since:
    
    100.9.0
  - getItemRenderingRule
```
public RenderingRule getItemRenderingRule()
```
    Gets the rendering rule applied on items before mosaic operation.
    
    Returns:
    
    rendering rule applied on items before mosaic operation, or null if none
    
    Since:
    
    100.9.0
  - setItemRenderingRule
```
public void setItemRenderingRule(RenderingRule itemRenderingRule)
```
    Sets the rendering rule applied on items before mosaic operation.
    
    Parameters:
    
    itemRenderingRule - rendering rule applied on items before mosaic operation. Can be null.
    
    Since:
    
    100.9.0
  - getLockRasterIds
```
public java.util.List<java.lang.Long> getLockRasterIds()
```
    Gets the collection of raster IDs for image service rasters forced to be visible at all scales. Used with MosaicMethod.LOCK_RASTER. Cannot be greater than the maximum mosaic image count of the service.
    
    Returns:
    
    a mutable collection of raster IDs for image service rasters forced to be visible at all scales
    
    Since:
    
    100.9.0
  - getMosaicMethod
```
public MosaicMethod getMosaicMethod()
```
    Gets the type of mosaic method used for individual images. The default value is the value used when the mosaic data was created, if unavailable, the default value is MosaicMethod.NONE.
    
    Returns:
    
    specifies the type of mosaic method used for individual images
    
    Since:
    
    100.9.0
  - setMosaicMethod
```
public void setMosaicMethod(MosaicMethod mosaicMethod)
```
    Sets the type of mosaic method used for individual images.
    
    Parameters:
    
    mosaicMethod - specifies the type of mosaic method used for individual images
    
    Throws:
    
    java.lang.IllegalArgumentException - if mosaicMethod is null
    
    Since:
    
    100.9.0
  - getMosaicOperation
```
public MosaicOperation getMosaicOperation()
```
    Specifies the mosaic operation used to resolve overlapped pixel values. The default value is the value used when the mosaic data was created, if unavailable, the default value is MosaicOperation.FIRST.
    
    Returns:
    
    specifies the mosaic operation used to resolve overlapped pixel values
    
    Since:
    
    100.9.0
  - setMosaicOperation
```
public void setMosaicOperation(MosaicOperation mosaicOperation)
```
    Specifies the mosaic operation used to resolve overlapped pixel values.
    
    Parameters:
    
    mosaicOperation - specifies the mosaic operation used to resolve overlapped pixel values
    
    Throws:
    
    java.lang.IllegalArgumentException - if mosaicOperation is null
    
    Since:
    
    100.9.0
  - getRasterIds
```
public java.util.List<java.lang.Long> getRasterIds()
```
    Gets the collection of raster IDs specifying a subset of rasters used in the mosaic. Any of the specified rasters may not be visible at all scales.
    
    Returns:
    
    a mutable collection of raster IDs specifying a subset of rasters used in the mosaic
    
    Since:
    
    100.9.0
  - getSortField
```
public java.lang.String getSortField()
```
    Gets the field name used together with MosaicMethod.ATTRIBUTE.
    
    Returns:
    
    the field name used together with MosaicMethod.ATTRIBUTE
    
    Since:
    
    100.9.0
  - setSortField
```
public void setSortField(java.lang.String sortField)
```
    Sets the field name used together with MosaicMethod.ATTRIBUTE.
    
    Parameters:
    
    sortField - the field name used together with MosaicMethod.ATTRIBUTE
    
    Throws:
    
    java.lang.IllegalArgumentException - if sortField is null
    
    Since:
    
    100.9.0
  - getSortValue
```
public java.lang.String getSortValue()
```
    Gets the base sort value used together with MosaicMethod.ATTRIBUTE and getSortField().
    
    Returns:
    
    the base sort value used together with MosaicMethod.ATTRIBUTE and getSortField
    
    Since:
    
    100.9.0
  - setSortValue
```
public void setSortValue(java.lang.String sortValue)
```
    Sets the base sort value used together with MosaicMethod.ATTRIBUTE and getSortField().
    
    Parameters:
    
    sortValue - the base sort value used together with MosaicMethod.ATTRIBUTE and getSortField
    
    Throws:
    
    java.lang.IllegalArgumentException - if sortValue is null
    
    Since:
    
    100.9.0
  - getViewpoint
```
public Viewpoint getViewpoint()
```
    Gets the viewpoint used along with MosaicMethod.VIEWPOINT.
    
    Returns:
    
    the viewpoint used along with MosaicMethod.VIEWPOINT, or null if none
    
    Since:
    
    100.9.0
  - setViewpoint
```
public void setViewpoint(Viewpoint viewpoint)
```
    Sets the viewpoint used along with MosaicMethod.VIEWPOINT.
    
    Parameters:
    
    viewpoint - the viewpoint used along with MosaicMethod.VIEWPOINT. Can be null.
    
    Since:
    
    100.9.0
  - getWhereClause
```
public java.lang.String getWhereClause()
```
    Gets the SQL WHERE clause to define a subset of rasters used in the mosaic. Any of the rasters in the subset may not be visible at all scales.
    
    Returns:
    
    SQL WHERE clause to define a subset of rasters used in the mosaic
    
    Since:
    
    100.9.0
  - setWhereClause
```
public void setWhereClause(java.lang.String whereClause)
```
    Sets the SQL WHERE clause to define a subset of rasters used in the mosaic. Any of the rasters in the subset may not be visible at all scales.
    
    Parameters:
    
    whereClause - SQL WHERE clause to define a subset of rasters used in the mosaic
    
    Throws:
    
    java.lang.IllegalArgumentException - if whereClause is null
    
    Since:
    
    100.9.0

Class MosaicRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MosaicRule

Method Detail

isAscending

setAscending

getItemRenderingRule

setItemRenderingRule

getLockRasterIds

getMosaicMethod

setMosaicMethod

getMosaicOperation

setMosaicOperation

getRasterIds

getSortField

setSortField

getSortValue

setSortValue

getViewpoint

setViewpoint

getWhereClause

setWhereClause