public static class TLfnRasterCoverageMetadata.Builder extends ALfnCoverageMetadata.Builder<TLfnRasterCoverageMetadata.Builder>
TLfnRasterCoverageMetadata
Modifier and Type | Method and Description |
---|---|
TLfnRasterCoverageMetadata.Builder |
areaOfInterest(ILcdBounds aAreaOfInterest)
Sets the area of interest for this raster coverage.
|
TLfnRasterCoverageMetadata.Builder |
bandSemantics(Collection<? extends ALcdBandSemantics> aBandSemantics)
Sets the band semantics of the coverageExplicitly sets the variable which stores the band semantics information.
|
TLfnRasterCoverageMetadata |
build()
Builds an immutable raster coverage metadata.
|
TLfnRasterCoverageMetadata.Builder |
dimensions(Collection<? extends ILcdDimension<?>> aDimensions)
Sets the dimensional filters, used for filtering multi-dimensional data such as NetCDF weather data.
|
int[] |
getLevelsToProduce()
Deprecated.
fusion ignores this setting. The levels to produce are now always detected automatically
based on the overlapping asset's resolutions.
|
int |
getTileHeight()
Gets this builder's current tile height.
|
int |
getTileWidth()
Gets this builder's current tile width.
|
boolean |
isOptimizeForSquarePixels()
Tells if this builder may optimize the coverage layout, tile size and bounding box to enforce square pixels.
|
boolean |
isPreserveAssetOrder()
Indicates in what order the assets will be fused.
|
TLfnRasterCoverageMetadata.Builder |
levelsToProduce(int[] aLevelsToProduce)
Deprecated.
fusion ignores this setting. The levels to produce are now always detected automatically
based on the overlapping asset's resolutions.
|
TLfnRasterCoverageMetadata.Builder |
optimizeForSquarePixels(boolean aOn)
Optimizes the coverage layout upon build, tile size and bounding box to arrive at square pixels.
|
TLfnRasterCoverageMetadata.Builder |
parameters(Collection<? extends TLcdEarthMultivaluedDataParameter> aParameters)
Sets the optional multi-valued parameters of the coverage.
|
TLfnRasterCoverageMetadata.Builder |
parameters(TLcdEarthMultivaluedDataParameter... aParameters)
Sets the optional multi-valued parameters of the coverage.
|
TLfnRasterCoverageMetadata.Builder |
preserveAssetOrder()
Overrides the default asset order the fusion process will use.
|
TLfnRasterCoverageMetadata.Builder |
preserveAssetOrder(boolean aPreserveAssetOrder)
Overrides the default asset order the fusion process will use.
|
TLfnRasterCoverageMetadata.Builder |
produceAllLevels()
Deprecated.
fusion ignores this setting. The levels to produce are now always detected automatically
based on the overlapping asset's resolutions.
|
TLfnRasterCoverageMetadata.Builder |
produceAllLevels(boolean aOn)
Deprecated.
fusion ignores this setting. The levels to produce are now always detected automatically
based on the overlapping asset's resolutions.
|
TLfnRasterCoverageMetadata.Builder |
samplingMode(ELcdImageSamplingMode aSamplingMode)
Sets the sampling mode for this coverage.
|
TLfnRasterCoverageMetadata.Builder |
setTileHeight(int aTileHeight)
Deprecated.
use
tileHeight(int) instead |
TLfnRasterCoverageMetadata.Builder |
setTileLayout(int aTileWidth,
int aTileHeight)
Deprecated.
use
tileSize(int, int) instead |
TLfnRasterCoverageMetadata.Builder |
setTileWidth(int aTileWidth)
Deprecated.
use
tileWidth(int) instead |
TLfnRasterCoverageMetadata.Builder |
tileHeight(int aTileHeight)
Sets the required height of the tiles in this coverage, which must be a non-zero value.
|
TLfnRasterCoverageMetadata.Builder |
tileSize(int aTileWidth,
int aTileHeight)
A convenience method for setting both the tile width and height.
|
TLfnRasterCoverageMetadata.Builder |
tileWidth(int aTileWidth)
Sets the required width of the tiles in this coverage, which must be a non-zero value.
|
TLfnRasterCoverageMetadata.Builder |
type(ELfnDataType aType)
Sets the required type of the coverage.
|
addAssetInfo, addAssetInfo, assetInfos, assetInfos, assetSourcesInTileStore, boundingBox, dataDensity, featureTypeStyles, featureTypeStyles, format, formatVersion, geoReference, getAssetInfos, getBoundingBox, getDataDensity, getFeatureTypeStyles, getFormat, getFormatVersion, getGeoReference, getLevel0ColumnCount, getLevel0RowCount, getMessageDigestAlgorithm, getScaleDenominators, getType, ignoreNonFatalFailures, ignoreNonFatalFailures, isAssetSourcesInTileStore, isIgnoreNonFatalFailures, layout, level0ColumnCount, level0RowCount, messageDigestAlgorithm, scaleDenominators, scaleDenominators, setAssetInfos, setAssetInfos, setBoundingBox, setCoverageLayout, setDataDensity, setFormat, setFormatVersion, setGeoReference, setLevel0ColumnCount, setLevel0RowCount, setMessageDigestAlgorithm, setScaleDenominators, setScaleDenominators, setType, tileFormat
abstract_, getAbstract, getGlobalUpdateSequence, getId, getISO19115Metadata, getName, getUpdateSequence, globalUpdateSequence, id, iso19115Metadata, name, setAbstract, setId, setISO19115Metadata, setName, setUpdateSequence, updateSequence
public TLfnRasterCoverageMetadata build()
build
in class ALfnCoverageMetadata.Builder<TLfnRasterCoverageMetadata.Builder>
NullPointerException
- in case one or more required fields have not been setpublic int getTileWidth()
public int getTileHeight()
public TLfnRasterCoverageMetadata.Builder parameters(TLcdEarthMultivaluedDataParameter... aParameters)
null
, the default parameters will be used.
The default parameters are the union of the asset's parameters, preserving list order and removing duplicates.
Calling this method without parameters will clear them.
aParameters
- an array of ordered parameters, or null
to reset to defaultpublic TLfnRasterCoverageMetadata.Builder parameters(Collection<? extends TLcdEarthMultivaluedDataParameter> aParameters)
null
, the default parameters will be used.
The default parameters are the union of the asset's parameters, preserving list order and removing duplicates.
Calling this method with empty parameters will clear them.
aParameters
- an ordered collection of parameters, or null
to reset to defaultpublic TLfnRasterCoverageMetadata.Builder samplingMode(ELcdImageSamplingMode aSamplingMode)
null
, the default sampling mode will be used.
The default sampling mode changes with the asset metadata.
POINT
if and only if all asset parts of all assets have sampling mode
POINT
.AREA
if at least one asset part has sampling mode AREA
.AREA
.aSamplingMode
- The sampling mode, null
to use the default sampling mode based on the assets.public TLfnRasterCoverageMetadata.Builder tileSize(int aTileWidth, int aTileHeight)
aTileWidth
- the width of the tiles in this coverage in pixelsaTileHeight
- the height of the tiles in this coverage in pixelspublic TLfnRasterCoverageMetadata.Builder setTileLayout(int aTileWidth, int aTileHeight)
tileSize(int, int)
insteadpublic TLfnRasterCoverageMetadata.Builder tileWidth(int aTileWidth)
If set to an illegal value, this method will throw immediately.
aTileWidth
- The width of the tiles in this coverage in pixels. Use a negative value to reset to default.public TLfnRasterCoverageMetadata.Builder setTileWidth(int aTileWidth)
tileWidth(int)
insteadpublic TLfnRasterCoverageMetadata.Builder tileHeight(int aTileHeight)
If set to the illegal value 0
, this method will throw immediately.
aTileHeight
- The height of the tiles in this coverage in pixels. Use a negative value to reset to default.public TLfnRasterCoverageMetadata.Builder setTileHeight(int aTileHeight)
tileHeight(int)
insteadpublic TLfnRasterCoverageMetadata.Builder levelsToProduce(int[] aLevelsToProduce)
public TLfnRasterCoverageMetadata.Builder produceAllLevels(boolean aOn)
public TLfnRasterCoverageMetadata.Builder produceAllLevels()
public int[] getLevelsToProduce()
null
public final TLfnRasterCoverageMetadata.Builder preserveAssetOrder(boolean aPreserveAssetOrder)
See TLfnRasterCoverageMetadata.isPreserveAssetOrder()
for more
details.
By default, this is false
.
aPreserveAssetOrder
- true
to fuse in order specified by ALfnCoverageMetadata.Builder.assetInfos(java.util.List<com.luciad.fusion.tilestore.metadata.ALfnCoverageMetadata.AssetInfo>)
,
false
to let the fusion process determine the order
automatically.public final TLfnRasterCoverageMetadata.Builder preserveAssetOrder()
See TLfnRasterCoverageMetadata.isPreserveAssetOrder()
for more
details.
By default, this is false
.
public boolean isPreserveAssetOrder()
See TLfnRasterCoverageMetadata.isPreserveAssetOrder()
for more
details.
By default, this is false
.
true
to fuse in order specified by ALfnCoverageMetadata.Builder.assetInfos(java.util.List<com.luciad.fusion.tilestore.metadata.ALfnCoverageMetadata.AssetInfo>)
, false
to let
the fusion process determine the order automatically.public final TLfnRasterCoverageMetadata.Builder optimizeForSquarePixels(boolean aOn)
aOn
- whether or not to optimize for square pixelspublic boolean isOptimizeForSquarePixels()
optimizeForSquarePixels(boolean)
public TLfnRasterCoverageMetadata.Builder dimensions(Collection<? extends ILcdDimension<?>> aDimensions)
When the coverage type is RASTER
, all possible values for all dimensions will be selected by default,
meaning that the coverage will preserve all the multi-dimensional information of the source data.
If desired, you can use this method to select a subset.
When the coverage type is IMAGE
, a single value for every dimension will be selected by default.
You can change the selection, but only a single possible value per dimension is allowed in this case.
Because you're rendering RGB images from multi-dimensional source data, this behaves as a dimensional filter
when visualizing the multi-dimensional data.
For example, if there are 2 levels {l0, l1} and 2 times {t0, t1} available, the
default dimensional filter will filter for the combination (min(t0, t1),
min(l0, l1)).
The fact that the minimum is the default rather than the first is a consequence of the implementation of
TLcdDimension
, which keeps its intervals sorted.
If multiple asset parts contribute to the coverage and they have different dimensions, the first occurrence of
a particular dimension will be used.
Because the dimensions are marshaled there are two points that you should take into account;
ILcdDimension
should have a finite set of possible
values: ILcdDimension.getValues()
must be finite.
This is virtually always the case in practice.
TLcdDimensionAxis.Builder.type(Class)
is
instantiated afterwards on the runtime with its fully qualified class name. Therefore you should never
obfuscate the type if you are using a user defined classes for it. As an example, implementations of
ILcdISO19103Measure
are not obfuscated because they are usually used for vertical
measure types for the dimension axes.aDimensions
- the dimensional filters to set, or null
to use the default dimensional filterspublic TLfnRasterCoverageMetadata.Builder bandSemantics(Collection<? extends ALcdBandSemantics> aBandSemantics)
TLfnRasterAssetMetadata
's also have variables and variable of the coverage is set automatically
when you add an asset to the coverage. All the TLfnRasterAssetMetaData
instances
in the raster coverage should have the same variable with the one defined in the coverage.aBandSemantics
- variable to be setIllegalArgumentException
- if there is already a defined variable in the builder and aVariable is not equal to it.public TLfnRasterCoverageMetadata.Builder areaOfInterest(ILcdBounds aAreaOfInterest)
This does not affect the coverage tile set structure which is determined by the bounding box (ALfnCoverageMetadata.Builder.boundingBox(ILcdBounds)
).
The area of interest is used as information that the data within the coverage has been clipped.
aAreaOfInterest
- the area of interest. It is defined in the geo-reference of the raster coverage.public TLfnRasterCoverageMetadata.Builder type(ELfnDataType aType)
ALfnCoverageMetadata.Builder
null
, the default type will be used.
For vector coverages, the default type is VECTOR
.
For raster coverages, the default type depends on the asset metadatas.
IMAGE
.IMAGE
since it is the greatest common denominator.For non-tiled coverages, the type is always null
.
type
in class ALfnCoverageMetadata.Builder<TLfnRasterCoverageMetadata.Builder>
aType
- a type, or null
to indicate the default type