com.luciad.imaging

LuciadFusionClass TLcdImageBuilder

java.lang.Object

com.luciad.imaging.TLcdImageBuilder

public class TLcdImageBuilder
extends Object

Builder for creating ALcdBasicImage or ALcdMultilevelImage instances.

Images can only be created from a single RenderedImage or one or more ALcdBasicImage, not both.

You can find the other available builders on com.luciad.imaging.

Since:

2015.0

Method Summary

Modifier and Type	Method and Description
TLcdImageBuilder	bounds(ILcdBounds aBounds) Set the image bounds.
ALcdBasicImage	buildBasicImage() Create a new ALcdBasicImage with the currently defined properties.
ALcdMultilevelImage	buildMultilevelImage() Create a new ALcdMultilevelImage with the currently defined properties.
TLcdImageBuilder	image(ALcdBasicImage aBasicImage) Add a source image.
TLcdImageBuilder	image(RenderedImage aRenderedImage) Add a source image.
TLcdImageBuilder	image(RenderedImage aRenderedImage, boolean aCacheTiles) Add a source image.
TLcdImageBuilder	imageReference(ILcdModelReference aImageReference) Set the image reference.
TLcdImageBuilder	images(List<ALcdBasicImage> aBasicImages) Add a list of images, each representing one level.
TLcdImageBuilder	levelRelationship(ELcdLevelRelationship aLevelRelationship) Set the level relationship.
static TLcdImageBuilder	newBuilder() Create a new image builder.
TLcdImageBuilder	samplingMode(ELcdImageSamplingMode aSamplingMode) Set the image sampling mode.
TLcdImageBuilder	semantics(List<? extends ALcdBandSemantics> aSemantics) Set the image band semantics.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newBuilder

public static TLcdImageBuilder newBuilder()

Create a new image builder.

Returns:

a new builder instance

buildBasicImage

public ALcdBasicImage buildBasicImage()
                               throws IllegalStateException

Create a new ALcdBasicImage with the currently defined properties. To create a basic image, a number of conditions must be met:

• Either a RenderedImage or a single ALcdBasicImage must be set.
• If a ALcdBasicImage is set, other parameters may be defined to override properties of the image.

Returns:

a new basic image

Throws:

IllegalStateException - when the above conditions are not met

buildMultilevelImage

public ALcdMultilevelImage buildMultilevelImage()
                                         throws IllegalStateException

Create a new ALcdMultilevelImage with the currently defined properties. To create a multi-level image, a number of conditions must be met:

• Either one or more ALcdBasicImage must be set or one or more RenderedImage must be set.
• The level relationship must be set.

Returns:

a new multilevel image

Throws:

IllegalStateException - when the above conditions are not met

image

public TLcdImageBuilder image(RenderedImage aRenderedImage)

Add a source image.

Remember that ALcdImage's are immutable, so the specified RenderedImage must also be immutable.

Parameters:

aRenderedImage - the source image

Returns:

this builder

image

public TLcdImageBuilder image(RenderedImage aRenderedImage,
                              boolean aCacheTiles)

Add a source image.

Remember that ALcdImage's are immutable, so the specified RenderedImage must also be immutable.

Parameters:

aRenderedImage - the source image

aCacheTiles - true if the decoded tiles should be cached, this should typically be enabled if the image does not perform caching internally

Returns:

this builder

image

public TLcdImageBuilder image(ALcdBasicImage aBasicImage)

Add a source image.

Parameters:

aBasicImage - the source image to add

Returns:

this builder

images

public TLcdImageBuilder images(List<ALcdBasicImage> aBasicImages)

Add a list of images, each representing one level.

Parameters:

aBasicImages - the images to be added

Returns:

this builder

bounds

public TLcdImageBuilder bounds(ILcdBounds aBounds)

Set the image bounds.

Parameters:

aBounds - the bounds

Returns:

this builder

imageReference

public TLcdImageBuilder imageReference(ILcdModelReference aImageReference)

Set the image reference.

Parameters:

aImageReference - the image reference

Returns:

this builder

semantics

public TLcdImageBuilder semantics(List<? extends ALcdBandSemantics> aSemantics)

Set the image band semantics.

Parameters:

aSemantics - the band semantics

Returns:

this builder

samplingMode

public TLcdImageBuilder samplingMode(ELcdImageSamplingMode aSamplingMode)

Set the image sampling mode.

The default value is @{code ELcdImageSamplingMode#AREA}.

Parameters:

aSamplingMode - the sampling mode

Returns:

this builder

levelRelationship

public TLcdImageBuilder levelRelationship(ELcdLevelRelationship aLevelRelationship)

Set the level relationship.

Parameters:

aLevelRelationship - the level relationship

Returns:

this builder