Package com.luciad.format.bci

Class TLcdBCIRasterModelDescriptor

java.lang.Object

com.luciad.model.TLcdModelDescriptor

com.luciad.format.raster.TLcdRasterModelDescriptor

com.luciad.format.bci.TLcdBCIRasterModelDescriptor

All Implemented Interfaces:

ILcdImageModelDescriptor, ILcdModelDescriptor, Serializable

public class TLcdBCIRasterModelDescriptor
extends TLcdRasterModelDescriptor
implements ILcdImageModelDescriptor

This TLcdRasterModelDescriptor contains additional information about BCI rasters.

Since:

7.0.17

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	COLOUR_CODED_RASTER	A color coded raster.
static final int	DIGITAL_ELEVATION_MAP	A digital elevation map.
static final int	DIGITAL_ELEVATION_VECTOR_HEIGHT_MAP	A digital elevation map with vector heights.
static final int	DIGITALIZED_MAP	A digitalized map, indicating a raster or satellite photo.
static final int	DIGITALIZED_THEMATIC_MAP	A digitalized thematic map.
static final int	MATRIX_CODES	A matrix with codes.
static final int	MATRIX_VALUES	A matrix with values.
static final int	MIXED_DATA_STRUCTURES	Mixed data structures.
static final int	MONOCHROME_RASTER	A monochrome raster.
static final int	MULTIBAND_RASTER	A multi band raster (RGB or YCbCr or other multi band imagery).
static final int	SECURITY_CONFIDENTIAL	Confidential.
static final int	SECURITY_RESTRICTED	Restricted.
static final int	SECURITY_SECRET	Secret.
static final int	SECURITY_TOP_SECRET	Top secret.
static final int	SECURITY_UNCLASSIFIED	Unclassified.
static final int	UNKNOWN_MAP_TYPE	Unknown map type.
static final int	VECTOR_LEVEL_0	Vector (Level 0 Topology - Spaghetti).
static final int	VECTOR_LEVEL_1	Vector (Level 1 Topology - Chain-node).
static final int	VECTOR_LEVEL_2	Vector (Level 2 Topology - Planar graph).
static final int	VECTOR_LEVEL_3	Vector (Level 3 Topology - Full topology).

Constructor Summary

Constructors

Constructor	Description
TLcdBCIRasterModelDescriptor(String aSourceName, String aDisplayName)	Creates a new TLcdBCIRasterModelDescriptor with the given source name and display name.

Method Summary

Modifier and Type	Method	Description
String	getAddress()	Returns the address of the originating agency of the map.
String	getCreationDate()	Returns the creation date of the map.
String	getDataType()	Returns the map type.
String	getDigestVersion()	Returns the digest version of the map.
String	getDowngradingDate()	Returns the downgrading date.
String	getDowngradingPermission()	Returns whether the agency's determination is required for downgrading.
String	getFreeText()	Returns the free text message.
String[]	getLegend()	Returns the legend of the thematic color map.
int	getMapType()	Returns the type of the map.
String	getMapVersion()	Returns the version of the data format.
String	getName()	Returns the name of the map.
String	getOriginator()	Returns the originating agency of the map.
String	getPaperDates()	Returns the creation dates of the map in paper version.
String	getPublicationDate()	Returns the publication date of the DIGEST version.
String	getReleasability()	Returns the releasability of the map.
int	getScale()	Returns the scale of the map.
int	getSecurityCode()	Returns the security classification.
int	getTypeCode()	Returns the type of the data structure.
boolean	isElevation()	Returns whether the BCI raster map is an elevation map.
void	setAddress(String aAddress)	Sets the address of the originating agency of the map.
void	setCreationDate(String aCreationDate)	Sets the creation date of the map.
void	setDataType(String aDataType)	Sets the map type.
void	setDigestVersion(String aDigestVersion)	Sets the DIGEST version of the map.
void	setDowngradingDate(String aDowngradingDate)	Sets the downgrading date.
void	setDowngradingPermission(String aDowngradingPermission)	Sets whether the agency's determination is required for downgrading.
void	setFreeText(String aFreeText)	Sets a free text message.
void	setLegend(String[] aLegend)	Sets the legend of the thematic color map, in case of a digitized thematic map.
void	setMapType(int aMapType)	Sets the type of the map.
void	setMapVersion(String aMapVersion)	Sets the version of the data format.
void	setName(String aName)	Sets the name of the map.
void	setOriginator(String aOriginator)	Sets the originating agency of the map.
void	setPaperDates(String aPaperDates)	Sets the creation dates of the map in paper version.
void	setPublicationDate(String aPublicationDate)	Sets the publication date of the DIGEST version.
void	setReleasability(String aReleasability)	Sets the releasability of the map.
void	setScale(int aScale)	Sets the scale of the map.
void	setSecurityCode(int aSecurityCode)	Sets the security classification.
void	setTypeCode(int aTypeCode)	Sets the type of the data structure.

Methods inherited from class com.luciad.format.raster.TLcdRasterModelDescriptor

setElevation

Methods inherited from class com.luciad.model.TLcdModelDescriptor

getDisplayName, getSourceName, getTypeName, setDisplayName, setSourceName, setTypeName, sourceNameToDisplayName

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.luciad.model.ILcdModelDescriptor

getDisplayName, getSourceName, getTypeName

Field Details

UNKNOWN_MAP_TYPE

public static final int UNKNOWN_MAP_TYPE

Unknown map type.

See Also:

• Constant Field Values

DIGITALIZED_MAP

public static final int DIGITALIZED_MAP

A digitalized map, indicating a raster or satellite photo.

See Also:

• Constant Field Values

DIGITAL_ELEVATION_MAP

public static final int DIGITAL_ELEVATION_MAP

A digital elevation map.

See Also:

• Constant Field Values

DIGITAL_ELEVATION_VECTOR_HEIGHT_MAP

public static final int DIGITAL_ELEVATION_VECTOR_HEIGHT_MAP

A digital elevation map with vector heights.

Not applicable for this decoder, which decodes the BCI raster format.

See Also:

• Constant Field Values

DIGITALIZED_THEMATIC_MAP

public static final int DIGITALIZED_THEMATIC_MAP

A digitalized thematic map.

See Also:

• Constant Field Values

MONOCHROME_RASTER

public static final int MONOCHROME_RASTER

A monochrome raster.

See Also:

• Constant Field Values

MATRIX_VALUES

public static final int MATRIX_VALUES

A matrix with values.

See Also:

• Constant Field Values

MATRIX_CODES

public static final int MATRIX_CODES

A matrix with codes.

See Also:

• Constant Field Values

MULTIBAND_RASTER

public static final int MULTIBAND_RASTER

A multi band raster (RGB or YCbCr or other multi band imagery).

See Also:

• Constant Field Values

COLOUR_CODED_RASTER

public static final int COLOUR_CODED_RASTER

A color coded raster.

See Also:

• Constant Field Values

VECTOR_LEVEL_0

public static final int VECTOR_LEVEL_0

Vector (Level 0 Topology - Spaghetti).

Not applicable for this decoder, which decodes the BCI raster format.

See Also:

• Constant Field Values

VECTOR_LEVEL_1

public static final int VECTOR_LEVEL_1

Vector (Level 1 Topology - Chain-node).

Not applicable for this decoder, which decodes the BCI raster format.

See Also:

• Constant Field Values

VECTOR_LEVEL_2

public static final int VECTOR_LEVEL_2

Vector (Level 2 Topology - Planar graph).

Not applicable for this decoder, which decodes the BCI raster format.

See Also:

• Constant Field Values

VECTOR_LEVEL_3

public static final int VECTOR_LEVEL_3

Vector (Level 3 Topology - Full topology).

Not applicable for this decoder, which decodes the BCI raster format.

See Also:

• Constant Field Values

MIXED_DATA_STRUCTURES

public static final int MIXED_DATA_STRUCTURES

Mixed data structures.

See Also:

• Constant Field Values

SECURITY_TOP_SECRET

public static final int SECURITY_TOP_SECRET

Top secret.

See Also:

• Constant Field Values

SECURITY_SECRET

public static final int SECURITY_SECRET

Secret.

See Also:

• Constant Field Values

SECURITY_CONFIDENTIAL

public static final int SECURITY_CONFIDENTIAL

Confidential.

See Also:

• Constant Field Values

SECURITY_RESTRICTED

public static final int SECURITY_RESTRICTED

Restricted.

See Also:

• Constant Field Values

SECURITY_UNCLASSIFIED

public static final int SECURITY_UNCLASSIFIED

Unclassified.

See Also:

• Constant Field Values

Constructor Details

TLcdBCIRasterModelDescriptor

public TLcdBCIRasterModelDescriptor(String aSourceName,
 String aDisplayName)

Creates a new TLcdBCIRasterModelDescriptor with the given source name and display name.

The type name is automatically set to BCI.

Parameters:

aSourceName - the name of the data source.

aDisplayName - the display name of the data source.

Method Details

getMapVersion

public String getMapVersion()

Returns the version of the data format.

Returns:

the version of the data format.

setMapVersion

public void setMapVersion(String aMapVersion)

Sets the version of the data format.

Parameters:

aMapVersion - the version of the data format.

getName

public String getName()

Returns the name of the map.

Returns:

the name of the map.

setName

public void setName(String aName)

Sets the name of the map.

Parameters:

aName - the name of the map.

getOriginator

public String getOriginator()

Returns the originating agency of the map.

Returns:

the originating agency of the map.

setOriginator

public void setOriginator(String aOriginator)

Sets the originating agency of the map.

Parameters:

aOriginator - the originating agency of the map.

getAddress

public String getAddress()

Returns the address of the originating agency of the map.

Returns:

the address of the originating agency of the map.

setAddress

public void setAddress(String aAddress)

Sets the address of the originating agency of the map.

Parameters:

aAddress - the address of the originating agency of the map.

getTypeCode

public int getTypeCode()

Returns the type of the data structure.

Returns:

MONOCHROME_RASTER, MATRIX_VALUES, MATRIX_CODES, MULTIBAND_RASTER, COLOUR_CODED_RASTER, VECTOR_LEVEL_0, VECTOR_LEVEL_1, VECTOR_LEVEL_2, VECTOR_LEVEL_3, or MIXED_DATA_STRUCTURES.

setTypeCode

public void setTypeCode(int aTypeCode)

Sets the type of the data structure.

Parameters:

aTypeCode - MONOCHROME_RASTER, MATRIX_VALUES, MATRIX_CODES, MULTIBAND_RASTER, COLOUR_CODED_RASTER, VECTOR_LEVEL_0, VECTOR_LEVEL_1, VECTOR_LEVEL_2, VECTOR_LEVEL_3, or MIXED_DATA_STRUCTURES.

getSecurityCode

public int getSecurityCode()

Returns the security classification.

Returns:

SECURITY_UNCLASSIFIED, SECURITY_RESTRICTED, SECURITY_CONFIDENTIAL, SECURITY_SECRET, or SECURITY_TOP_SECRET.

setSecurityCode

public void setSecurityCode(int aSecurityCode)

Sets the security classification.

Parameters:

aSecurityCode - SECURITY_UNCLASSIFIED, SECURITY_RESTRICTED, SECURITY_CONFIDENTIAL, SECURITY_SECRET, or SECURITY_TOP_SECRET.

getDowngradingPermission

public String getDowngradingPermission()

Returns whether the agency's determination is required for downgrading.

Returns:

whether the agency's determination is required for downgrading.

setDowngradingPermission

public void setDowngradingPermission(String aDowngradingPermission)

Sets whether the agency's determination is required for downgrading.

Parameters:

aDowngradingPermission - whether the agency's determination is required for downgrading.

getDowngradingDate

public String getDowngradingDate()

Returns the downgrading date.

Returns:

the downgrading date.

setDowngradingDate

public void setDowngradingDate(String aDowngradingDate)

Sets the downgrading date.

Parameters:

aDowngradingDate - the downgrading date.

getReleasability

public String getReleasability()

Returns the releasability of the map.

Returns:

the releasability of the map.

setReleasability

public void setReleasability(String aReleasability)

Sets the releasability of the map.

Parameters:

aReleasability - the releasability of the map.

getDigestVersion

public String getDigestVersion()

Returns the digest version of the map.

Returns:

the digest version of the map.

setDigestVersion

public void setDigestVersion(String aDigestVersion)

Sets the DIGEST version of the map.

Parameters:

aDigestVersion - the DIGEST version of the map.

getPublicationDate

public String getPublicationDate()

Returns the publication date of the DIGEST version.

Returns:

the publication date of the DIGEST version.

setPublicationDate

public void setPublicationDate(String aPublicationDate)

Sets the publication date of the DIGEST version.

Parameters:

aPublicationDate - the publication date of the DIGEST version.

getDataType

public String getDataType()

Returns the map type.

Returns:

if defined, MAP, GEO, or DIG.

setDataType

public void setDataType(String aDataType)

Sets the map type.

Parameters:

aDataType - MAP, GEO, or DIG.

getScale

public int getScale()

Returns the scale of the map.

The scale value is purely informational and must be interpreted as 1 / scale_value.

Returns:

the scale of the map.

setScale

public void setScale(int aScale)

Sets the scale of the map.

Parameters:

aScale - the scale of the map.

getMapType

public int getMapType()

Returns the type of the map.

Returns:

UNKNOWN_MAP_TYPE, DIGITALIZED_MAP, DIGITAL_ELEVATION_MAP, DIGITAL_ELEVATION_VECTOR_HEIGHT_MAP, or DIGITALIZED_THEMATIC_MAP.

setMapType

public void setMapType(int aMapType)

Sets the type of the map.

Parameters:

aMapType - UNKNOWN_MAP_TYPE, DIGITALIZED_MAP, DIGITAL_ELEVATION_MAP, DIGITAL_ELEVATION_VECTOR_HEIGHT_MAP, or DIGITALIZED_THEMATIC_MAP.

getLegend

public String[] getLegend()

Returns the legend of the thematic color map.

A thematic color map and its legend are only defined when the map is of the type DIGITALIZED_THEMATIC_MAP (see getMapType().

If available, the legend consists of an array of 256 String values. Each value corresponds to the description of the color in the IndexedColorModel of the BCI raster that has the same index. The color model can be retrieved through ALcdBandColorSemantics.getPalette().

Returns:

the legend of the thematic color map, in case of a digitized thematic map.

setLegend

public void setLegend(String[] aLegend)

Sets the legend of the thematic color map, in case of a digitized thematic map.

Parameters:

aLegend - the legend of the thematic color map.

isElevation

public boolean isElevation()

Returns whether the BCI raster map is an elevation map. This depends on the map type (see getMapType()), which is DIGITAL_ELEVATION_MAP or DIGITAL_ELEVATION_VECTOR_HEIGHT_MAP in case of elevation data.

Overrides:

isElevation in class TLcdRasterModelDescriptor

Returns:

true if the BCI raster map is an elevation map.

getPaperDates

public String getPaperDates()

Returns the creation dates of the map in paper version.

Returns:

the creation dates of the map in paper version.

setPaperDates

public void setPaperDates(String aPaperDates)

Sets the creation dates of the map in paper version.

Parameters:

aPaperDates - the creation dates of the map in paper version.

getCreationDate

public String getCreationDate()

Returns the creation date of the map.

Returns:

the creation date of the map.

setCreationDate

public void setCreationDate(String aCreationDate)

Sets the creation date of the map.

Parameters:

aCreationDate - the creation date of the map.

getFreeText

public String getFreeText()

Returns the free text message.

Returns:

the free text message.

setFreeText

public void setFreeText(String aFreeText)

Sets a free text message.

Parameters:

aFreeText - a free text message.