TLcdVPFModelDecoder (LuciadFusion API documentation)

java.lang.Object
- com.luciad.format.vpf.TLcdVPFModelDecoder

All Implemented Interfaces:: ILcdInputStreamFactoryCapable, ILcdModelDecoder

@LcdService(service=ILcdModelDecoder.class,
            priority=20000)
public class TLcdVPFModelDecoder
extends Object
implements ILcdModelDecoder, ILcdInputStreamFactoryCapable

This model decoder decodes Vector Product Format (VPF) data into ILcdModel objects

Input

Required files

Feature classes can be decoded in two different ways:
- by passing a VPF properties file or object decoder
- by passing a TLcdVPFFeatureClass object to the decoder

VPF databases are structured using many relatively small files and directories, reflecting the internal structure of the database. Some files are mandatory, some are optional. Not all files are used by the model decoder. The following table gives an overview of the file structure of a VPF database.

File	Description	Usage
database/		one
dht	Database Header Table	mandatory
dqt	Data Quality Table	optional
dqx	Data Quality Table Index	optional
lat	Library Attribute Table	mandatory
library/		one for each library
cat	Coverage Attribute Table	mandatory
dqt	Data Quality Table	optional
dqx	Data Quality Table Index	optional
grt	Geographic Reference Table	mandatory
lht	Library Header Table	mandatory
coverage/		one for each coverage
char.vdt	Character Value Description Table	optional
dqt	Data Quality Table	optional
dqx	Data Quality Table Index	optional
fca	Feature Class Attribute Table	optional
fcs	Feature Class Schema Table	mandatory
fcx	Feature Class Schema Table Index	optional
int.vdt	Integer Value Description Table	optional
*.abr	Area Bounding Rectangle Table	not used
*.aft	Area Feature Table	one for each area feature class
*.ajt	Area Join Table	optional, depends on the feature-primitive multiplicity
*.ati	Area Thematic Index	not used
*.cbr	Complex Bounding Rectangle Table	not used
*.cft	Complex Feature Table	one for each complex feature class
*.cjt	Complex Join Table	optional, depends on the feature-primitive multiplicity
*.cti	Complex Thematic Index	not used
*.doc	Narrative Table	not used
*.dpt	Diagnostic Point Table	not used
*.fit	Feature Index Table	not used
*.fti	Feature Index Table Thematic Index	not used
*.jti	Join Thematic Index	not used
*.lbr	Line Bounding Rectangle Table	not used
*.lft	Line Feature Table	one for each line feature class
*.ljt	Line Join Table	optional, depends on the feature-primitive multiplicity
*.lti	Line Thematic Index	not used
*.pbr	Point Bounding Rectangle Table	not used
*.pft	Point Feature Table	one for each point feature class
*.pjt	Point Join Table	optional, depends on the feature-primitive multiplicity
*.pti	Point Thematic Index	not used
*.rat	Related Attribute Table	not used
*.rpt	Registration Point Table	not used
*.tft	Text Feature Table	one for each text feature class
*.tti	Text Thematic Index	not used
[a-z]/[a-z]/[a-z]/[a-z/		up to 4 levels deep, one leaf directory per tile
cnd	Connected Node Primitive Table	mandatory if connected node primitives exist in this tile
csi	Connected Node Spatial Index	optional, speeds up the model access
ebr	Edge Bounding Rectangle Table	not used
edg	Edge Primitive Table	mandatory if edge or face primitives exist in this tile
end	Entity Node Primitive Table	mandatory if entity node primitives exist in this tile
esi	Edge Spatial Index	optional, speeds up the model access
fac	Face Primitive Table	mandatory if face primitives exist in this tile
fbr	Face Bounding Rectangle Table	not used
fsi	Face Spatial Index	optional, speeds up the model access
nsi	Entity Node Spatial Index	optional, speeds up the model access
rng	Ring Table	mandatory if face primitives exist in this tile
txt	Text Primitive Table	mandatory if text primitives exist in this tile
tsi	Text Spatial Index	optional, speeds up the model access

The model decoder supports four different notations for each file:
- file (lowercase, without end dot)
- file. (lowercase, with end dot)
- FILE (uppercase, without end dot)
- FILE. (uppercase, with end dot)

Supported transfer protocols

This model decoder supports any transfer protocol, supported by the ILcdInputStreamFactory that is set on this decoder.

Model structure

This model decoder creates a model per VPF feature class. Only one feature class can be decoded at a time. There is no additional hierarchy in the models.
All models returned by this model decoder implement ILcd2DBoundsIndexedModel.
The current implementation of the model decoder returns models that are extensions of TLcd2DBoundsIndexedModelList. Users of the API should not rely on this.

Model descriptor

All models returned by this model decoder have a TLcdVPFModelDescriptor.

Model reference

All models returned by this model decoder have an ILcdGridReference or an ILcdGeodeticReference.

Model elements

All domain objects implement ILcdVPFFeature, which combines the ILcdVPFFACCFeature, ILcdDataObject and ILcdFeatured interfaces.
There are two model element modes, ELEMENT_PER_GEOMETRY and ELEMENT_PER_FEATURE. In the former mode, there is an element in the model per geometry in the data, in the latter mode there is an element in the model per feature in the data (a feature may be linked to multiple geometries.

Depending on the feature type and model element mode, domain objects also implement the following additional interfaces:

Model element mode	VPF Feature type	LuciadLightspeed interface
ELEMENT_PER_GEOMETRY	Point feature type	`ILcdPoint`
ELEMENT_PER_GEOMETRY	Line feature type	`ILcdPolyline`
ELEMENT_PER_GEOMETRY	Area feature type	`ILcdComplexPolygon, ILcdSurface`
ELEMENT_PER_GEOMETRY	Text feature type	`ILcdText`
ELEMENT_PER_FEATURE	Point feature type	`ILcdShapeList containing ILcdPoint shapes`
ELEMENT_PER_FEATURE	Line feature type	`ILcdShapeList containing ILcdPolyline shapes`
ELEMENT_PER_FEATURE	Area feature type	`ILcdShapeList containing ILcdComplexPolygon+ILcdSurface shapes`
ELEMENT_PER_FEATURE	Text feature type	`ILcdShapeList containing ILcdText shapes`

Useful settings

If a VPF properties file or object is passed to the decoder, the following properties can/should be present:

Property	Mandatory	Description
`lcd.vpf.dbpath`	x	the path to the VPF database's DHT file
`lcd.vpf.library`	x	the name of the library
`lcd.vpf.coverage`	x	the name of the coverage
`lcd.vpf.point`		the name of a point feature class to decode
`lcd.vpf.line`		the name of a line feature class to decode
`lcd.vpf.area`		the name of a area feature class to decode
`lcd.vpf.text`		the name of a text feature class to decode
`lcd.vpf.lowerleftX`		the lowerleft X coordinate of the decoding bounds
`lcd.vpf.lowerleftY`		the lowerleft Y coordinate of the decoding bounds
`lcd.vpf.width`		the width of the decoding bounds
`lcd.vpf.height`		the height of the decoding bounds

Sample code


   ILcdModelDecoder decoder = new TLcdVPFModeldecoder();
   ILcdModel model = decoder.decode("Data/VMap/vmaplv0/dht");

Performance tips

There are three different model types available (see also the ModelType documentation and the VPF developer guide for more information):
- IN_MEMORY_MODEL: use this model when constant performance is required, or decoding time and memory usage are unimportant.
- ON_THE_FLY_MODEL: use this model when very little memory is available.
- HYBRID_MODEL: use this model in all other cases.
By default, the HYBRID_MODEL is used by this model decoder.
For the element mode ELEMENT_PER_FEATURE, only the HYBRID_MODEL model type is supported. other model type settings will be ignored. The ELEMENT_PER_GEOMETRY mode may be faster and consume slightly less memory than the ELEMENT_PER_FEATURE mode, when both using the HYBRID_MODEL model type. By default, the ELEMENT_PER_GEOMETRY is used by this model decoder.
When the ModelType.ON_THE_FLY_MODEL or the ModelType.HYBRID_MODEL are used, increasing the JVM memory might improve decoding performance drastically.
The geometry of VPF features is grouped and read per coverage. Selecting all feature classes of a coverage will consume less memory and be faster than selecting one feature class of all coverages.
Spatial indices are optional, but can improve performance significantly.
When variable-length index files are missing, the indices are computed on-the-fly. This adds a small performance overhead.
When no variable-length index is available for a table (typically when there are no variable-length fields in the table), the number of records is computed by inspecting the file size. If another source than a file system is used (e.g. the Internet), for which the file size is not directly available, this will add an extra performance overhead.

Thread safety

This model decoder can be used safely in a multi-threading environment.
If the geographical extent of a model needs to be limited per model, one should pass the decoding bounds object via one of the decode() methods, not via the setDecodingBounds() method

Supported versions and specifications

This model decoder supports any VPF product, encoded according to the MIL-STD-2407 standard (28 June 1996). No assumptions are made on the product type (VMAP0, VMAP1, VMAP2, DNC, ...)

Known limitations

VPF complex feature classes are currently not supported.
Decoding bounds can be passed to the decoder, to limit the spatial extent of the model to be decoded. It's possible that some objects will be partly inside and partly outside the decoding bounds. The model's applyOnInteract operation will only apply functions on these objects if the applying bounds interact with the part of the object that is within the decoding bounds. This might result in unexpected behaviour outside the decoding bounds, e.g., an object might be completely painted while only the part inside the decoding bounds is selectable.
Only the inverted-list thematic index of a VPF database is taken into account. That does not mean that databases using a bit-array thematic index will not work, but the access time will be slower in those cases.

Requirements

The current implementation requires JRE 1.2 or higher.
The current implementation requires native libraries.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TLcdVPFModelDecoder.ModelElementMode` Enumeration defining the available model element modes for VPF.
`static class`	`TLcdVPFModelDecoder.ModelType` Type-safe enumeration containing the model types that are available in VPF.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AREA` Property name for the list of VPF area feature class names, separated by a ';', which to decode.
`static String`	`COMPLEX` Property name for the list of VPF complex feature class names, separated by a ';', which to decode.
`static String`	`COVERAGE_NAME` Property name for the name of the VPF coverage of which to decode the features.
`static String`	`DB_PATH` Property name for the path to the VPF databases DHT file.
`static String`	`DISPLAY_NAME` Property name for the display name to be used.
`static String`	`GEODETIC` Property value to indicate the reference of the limiting bounds are in geodetic coordinates.
`static String`	`HEIGHT` Property name for the height of the limiting bounds.
`static int`	`HIGH_MEMORY` Deprecated. The `ModelType` class is used now to indicate/configure the model type of a VPF model.
`static String`	`LIBRARY_NAME` Property name for the name of the VPF library.
`static String`	`LINE` Property name for the list of VPF line feature class names, separated by a ';', which to decode.
`static int`	`LOW_MEMORY` Deprecated. The `ModelType` class is used now to indicate/configure the model type of a VPF model.
`static String`	`LOWER_LEFT_X` Property name for the abscis of the lower left point of the limiting bounds.
`static String`	`LOWER_LEFT_Y` Property name for the ordinate of the lower left point of the limiting bounds.
`static String`	`LUCIAD_PREFIX` Property prefix.
`static String`	`POINT` Property name for the list of VPF point feature class names , separated by a ';', which to decode.
`static String`	`PROJECTION` Property value to indicate the reference of the limiting bounds are in grid coordinates.
`static String`	`REFERENCE` Property name to indicate the type of reference of the limiting bounds.
`static String`	`SOURCE_NAME` Property name for the source name to be used.
`static String`	`TEXT` Property name for the list of VPF text feature class names, separated by a ';', which to decode.
`static String`	`WIDTH` Property name for the width of the limiting bounds.

Constructor Summary

Constructors
Constructor and Description
`TLcdVPFModelDecoder()` Constructs a new `TLcdVPFModelDecoder`.
`TLcdVPFModelDecoder(ILcdBuffer aBuffer)` Deprecated. A buffer is no longer used to load VPF data. Use the constructor without arguments instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`canDecodeSource(String aString)` Checks whether this model decoder can decode the specified data source.
`ILcdModel`	`decode(Properties aProperties)` Retrieves the VPF feature class defined by this properties, and returns a model containing the features from this feature class.
`ILcdModel`	`decode(Properties aProperties, ILcdBounds aBounds)` Retrieves the VPF feature class defined by this properties file, and constructs a model containing the features from this feature class.
`ILcdModel`	`decode(String aSourceName)` Decode the specified file into a model.
`ILcdModel`	`decode(String aSourceName, ILcdBounds aBounds)` Decode the specified file into a model.
`ILcdModel`	`decode(TLcdVPFFeatureClass aFeatureClass)` Returns a model containing the features from the specified feature class.
`ILcdModel`	`decode(TLcdVPFFeatureClass aFeatureClass, ILcdBounds aBounds)` Returns a model containing the features from the specified feature class.
`ILcdBounds`	`getDecodingBounds()` Returns the default outermost bounds that are used for limiting the area in which to decode VPF data.
`String`	`getDefaultExtension()` Returns the default extension for `VPF` properties files.
`String`	`getDisplayName()` Returns a short, displayable name for the format that is decoded by this `ILcdModelDecoder`.
`ILcdInputStreamFactory`	`getInputStreamFactory()` Returns the `ILcdInputStreamFactory` that is used by this model decoder to create input streams from.
`static int`	`getMemoryUsage()` Deprecated. Use the non-static `getModelType` method.
`TLcdVPFModelDecoder.ModelElementMode`	`getModelElementMode()` Returns the model element mode used by this model decoder.
`TLcdVPFModelDecoder.ModelType`	`getModelType()` Returns the model type that is used for decoding data.
`int`	`getThresholdForRegularTiledModel()` Deprecated. Don't use this method. This feature is not supported anymore.
`boolean`	`isDeepTraceOn()` Returns whether deep (detailed) logging is enabled for this object..
`boolean`	`isTraceOn()` Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
`boolean`	`isUseNullValues()` Returns whether attribute values representing the 'null/no value' value, should be represented as `null` or not.
`static void`	`setClassTraceOn(boolean aClassTraceOn)` Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
`void`	`setDecodingBounds(ILcdBounds aDecodingBounds)` Registers the default outermost bounds to be used for limiting the area in which to decode VPF data.
`void`	`setDeepTraceOn(boolean aDeepTraceOn)` Enabled deep (detailed) logging on this object.
`void`	`setInputStreamFactory(ILcdInputStreamFactory aInputStreamFactory)` Sets the `ILcdInputStreamFactory` to be used for creating `InputStreams`.
`static void`	`setMemoryUsage(int aUsage)` Deprecated. Use the non-static `setModelType` method instead, to indicate whether the decoder should create full (fast, but high memory usage) or empty (slower, but lower memory usage) models.
`void`	`setModelElementMode(TLcdVPFModelDecoder.ModelElementMode aElementMode)` Sets the model element mode to be used by this model decoder.
`void`	`setModelType(TLcdVPFModelDecoder.ModelType aModelType)` Sets the model types to be created when decoding data.
`void`	`setThresholdForRegularTiledModel(int aThresholdForRegularTiledModel)` Deprecated. Don't use this method. This feature is not supported anymore.
`void`	`setTraceOn(boolean aTraceOn)` Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
`void`	`setUseNullValues(boolean aUseNullValues)` Flag indicating whether attribute values representing the 'null/no value' value, should be represented as `null` or not.

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.ILcdModelDecoder
canDecodeSource, decodeModelMetadata, decodeModelMetadata, decodeSource, discoverDataSources

- Field Detail
  - LUCIAD_PREFIX
```
public static final String LUCIAD_PREFIX
```
    Property prefix. Is prepended to other property names.
    
    See Also:
    
    Constant Field Values
  - DB_PATH
```
public static final String DB_PATH
```
    Property name for the path to the VPF databases DHT file.
    
    See Also:
    
    Constant Field Values
  - LIBRARY_NAME
```
public static final String LIBRARY_NAME
```
    Property name for the name of the VPF library.
    
    See Also:
    
    Constant Field Values
  - COVERAGE_NAME
```
public static final String COVERAGE_NAME
```
    Property name for the name of the VPF coverage of which to decode the features.
    
    See Also:
    
    Constant Field Values
  - LINE
```
public static final String LINE
```
    Property name for the list of VPF line feature class names, separated by a ';', which to decode.
    
    See Also:
    
    Constant Field Values
  - POINT
```
public static final String POINT
```
    Property name for the list of VPF point feature class names , separated by a ';', which to decode.
    
    See Also:
    
    Constant Field Values
  - AREA
```
public static final String AREA
```
    Property name for the list of VPF area feature class names, separated by a ';', which to decode.
    
    See Also:
    
    Constant Field Values
  - TEXT
```
public static final String TEXT
```
    Property name for the list of VPF text feature class names, separated by a ';', which to decode.
    
    See Also:
    
    Constant Field Values
  - COMPLEX
```
public static final String COMPLEX
```
    Property name for the list of VPF complex feature class names, separated by a ';', which to decode.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_NAME
```
public static final String DISPLAY_NAME
```
    Property name for the display name to be used.
    
    See Also:
    
    Constant Field Values
  - SOURCE_NAME
```
public static final String SOURCE_NAME
```
    Property name for the source name to be used.
    
    See Also:
    
    Constant Field Values
  - LOWER_LEFT_X
```
public static final String LOWER_LEFT_X
```
    Property name for the abscis of the lower left point of the limiting bounds.
    
    See Also:
    
    Constant Field Values
  - LOWER_LEFT_Y
```
public static final String LOWER_LEFT_Y
```
    Property name for the ordinate of the lower left point of the limiting bounds.
    
    See Also:
    
    Constant Field Values
  - WIDTH
```
public static final String WIDTH
```
    Property name for the width of the limiting bounds.
    
    See Also:
    
    Constant Field Values
  - HEIGHT
```
public static final String HEIGHT
```
    Property name for the height of the limiting bounds.
    
    See Also:
    
    Constant Field Values
  - REFERENCE
```
public static final String REFERENCE
```
    Property name to indicate the type of reference of the limiting bounds. The value of this property should be either PROJECTION or GEODETIC.
    
    See Also:
    
    Constant Field Values
  - PROJECTION
```
public static final String PROJECTION
```
    Property value to indicate the reference of the limiting bounds are in grid coordinates.
    
    See Also:
    
    Constant Field Values
  - GEODETIC
```
public static final String GEODETIC
```
    Property value to indicate the reference of the limiting bounds are in geodetic coordinates.
    
    See Also:
    
    Constant Field Values
  - LOW_MEMORY
```
public static final int LOW_MEMORY
```
    Deprecated. The ModelType class is used now to indicate/configure the model type of a VPF model.
    
    Low memory model type. No data is cached in memory when this type is used. Uses less memory but is slower than the high memory model type.
    
    See Also:
    
    HIGH_MEMORY, Constant Field Values
  - HIGH_MEMORY
```
public static final int HIGH_MEMORY
```
    Deprecated. The ModelType class is used now to indicate/configure the model type of a VPF model.
    
    High memory model type. All model objects are kept in memory. Is faster but uses more memory than the low memory model type.
    
    See Also:
    
    LOW_MEMORY, Constant Field Values
- Constructor Detail
  - TLcdVPFModelDecoder
```
public TLcdVPFModelDecoder()
```
    Constructs a new TLcdVPFModelDecoder.
  - TLcdVPFModelDecoder
```
public TLcdVPFModelDecoder(ILcdBuffer aBuffer)
```
    Deprecated. A buffer is no longer used to load VPF data. Use the constructor without arguments instead.
    
    Constructs a new TLcdVPFModelDecoder.
    
    Parameters:
    
    aBuffer - This argument is not used.
- Method Detail
  - setDecodingBounds
```
public void setDecodingBounds(ILcdBounds aDecodingBounds)
```
    Registers the default outermost bounds to be used for limiting the area in which to decode VPF data. This bounds will only be used when no other bounds are passed to the decode methods. They should be specified in the coordinate system of the library.
    Decoding bounds have two purposes:
    - They can be used to limit the area which a user/application is allowed to see/use.
    - In case the IN_MEMORY_MODEL is used, they can be used to limit the amount of data to be read/loaded in memory.
    Parameters:
    
    aDecodingBounds - the default outermost bounds for VPF models.
    
    Throws:
    
    NullPointerException - if aDecodingBounds is null.
    
    See Also:
    
    getDecodingBounds()
  - getDecodingBounds
```
public ILcdBounds getDecodingBounds()
```
    Returns the default outermost bounds that are used for limiting the area in which to decode VPF data.
    
    Returns:
    
    the default outermost bounds for VPF models.
    
    See Also:
    
    setDecodingBounds(com.luciad.shape.ILcdBounds)
  - setInputStreamFactory
```
public void setInputStreamFactory(ILcdInputStreamFactory aInputStreamFactory)
```
    Sets the ILcdInputStreamFactory to be used for creating InputStreams. This factory is be used recursively throughout the VPF structures for decoding all VPF files. This factory is only used if a Properties source or object is passed to the decoder. If a TLcdVPFFeatureClass is passed to the decoder, this object's input stream factory will be used instead.
    
    Specified by:
    
    setInputStreamFactory in interface ILcdInputStreamFactoryCapable
    
    Parameters:
    
    aInputStreamFactory - the input stream factory to be used by this model decoder.
    
    See Also:
    
    getInputStreamFactory()
  - getInputStreamFactory
```
public ILcdInputStreamFactory getInputStreamFactory()
```
    Returns the ILcdInputStreamFactory that is used by this model decoder to create input streams from.
    
    Specified by:
    
    getInputStreamFactory in interface ILcdInputStreamFactoryCapable
    
    Returns:
    
    the ILcdInputStreamFactory that is used by this model decoder to create input streams from.
    
    See Also:
    
    setInputStreamFactory(com.luciad.io.ILcdInputStreamFactory)
  - setModelType
```
public void setModelType(TLcdVPFModelDecoder.ModelType aModelType)
```
    Sets the model types to be created when decoding data.
    
    Parameters:
    
    aModelType - the model type to be created.
    
    See Also:
    
    TLcdVPFModelDecoder.ModelType, getModelType()
  - getModelType
```
public TLcdVPFModelDecoder.ModelType getModelType()
```
    Returns the model type that is used for decoding data.
    
    Returns:
    
    the model type that is used.
    
    See Also:
    
    TLcdVPFModelDecoder.ModelType, setModelType(com.luciad.format.vpf.TLcdVPFModelDecoder.ModelType)
  - getModelElementMode
```
public TLcdVPFModelDecoder.ModelElementMode getModelElementMode()
```
    Returns the model element mode used by this model decoder.
    
    Returns:
    
    the model element mode used by this model decoder.
    
    See Also:
    
    TLcdVPFModelDecoder.ModelElementMode, setModelElementMode(com.luciad.format.vpf.TLcdVPFModelDecoder.ModelElementMode)
  - setModelElementMode
```
public void setModelElementMode(TLcdVPFModelDecoder.ModelElementMode aElementMode)
```
    Sets the model element mode to be used by this model decoder. The model element mode defines how features and geometries should be mapped onto ILcdModel elements. By default, the decoder uses TLcdVPFModelDecoder.ModelElementMode.ELEMENT_PER_GEOMETRY.
    
    Parameters:
    
    aElementMode - the model element mode to be used by this model decoder.
    
    See Also:
    
    TLcdVPFModelDecoder.ModelElementMode, getModelElementMode()
  - setUseNullValues
```
public void setUseNullValues(boolean aUseNullValues)
```
    Flag indicating whether attribute values representing the 'null/no value' value, should be represented as null or not. If false, the value from the data will be used. E.g. for a short, the value -32768 means 'no value'; if this flag is set to true, the attribute value will be null, whereas otherwise, it will be -32768.
    This flag only affects the behaviour of the ILcdFeatured interface of VPF objects. Its default value is false.
    Due to implementation restrictions, it is not possible to use different settings of this flag with a same instance of TLcdVPFFeatureClass.
    
    Parameters:
    
    aUseNullValues - flag indicating whether attribute values representing the 'null/no value' value, should be represented as null or not.
  - isUseNullValues
```
public boolean isUseNullValues()
```
    Returns whether attribute values representing the 'null/no value' value, should be represented as null or not.
    
    Returns:
    
    whether attribute values representing the 'null/no value' value, should be represented as null or not.
    
    See Also:
    
    setUseNullValues(boolean)
  - getDefaultExtension
```
public String getDefaultExtension()
```
    Returns the default extension for VPF properties files.
    
    Returns:
    
    "vpf".
  - getDisplayName
```
public String getDisplayName()
```
    Description copied from interface: ILcdModelDecoder
    
    Returns a short, displayable name for the format that is decoded by this ILcdModelDecoder.
    
    Specified by:
    
    getDisplayName in interface ILcdModelDecoder
    
    Returns:
    
    the displayable name of this ILcdModelDecoder.
  - canDecodeSource
```
public boolean canDecodeSource(String aString)
```
    Description copied from interface: ILcdModelDecoder
    
    Checks whether this model decoder can decode the specified data source. It is acceptable for this method to return true for a source name while decode throws an exception for that same source name.
    For performance reasons, we strongly recommend that this will only be a simple test. For example: check the file extension of a file, but not that the file exists or contains expected content.
    
    Specified by:
    
    canDecodeSource in interface ILcdModelDecoder
    
    Parameters:
    
    aString - the data source to be verified; typically a file name or a URL.
    
    Returns:
    
    true if this decoder can likely decode the data specified by the source name, false otherwise.
    
    See Also:
    
    ILcdModelDecoder.decode(String), ILcdModelDecoder.decodeModelMetadata(String)
  - decode
```
public ILcdModel decode(String aSourceName)
                 throws IOException
```
    Decode the specified file into a model. This can be either:
    - a properties file
    - a VPF feature table (point/line/area/text/complex)
    - a VPF database header table (dht)
    The following features will be included in the model.:
    - If a VPF database header table is used a source, all features of the VPF database will be decoded. The resulting model will be an instance of ILcdModelTreeNode. The model tree will have the same hierarchy as the VPF data. At the root level is the database node which contains a node for each available library. The library nodes contain the coverage nodes containing the feature class nodes.
    - If bounds are defined in the properties file, only the features within the specified bounds will be included.
    - Otherwise, if the decoding bounds set on this decoder are non-null, only the features within the decoding bounds will be included.
    - Otherwise, all features will be included.
    Specified by:
    
    decode in interface ILcdModelDecoder
    
    Parameters:
    
    aSourceName - source name specifying the properties file to be decoded.
    
    Returns:
    
    a model containing all features from the specified feature class within the limiting bounds, if specified.
    
    Throws:
    
    IOException - if an IO error occurs during the decoding.
    
    See Also:
    
    ILcdModelDecoder.canDecodeSource(String)
  - decode
```
public ILcdModel decode(String aSourceName,
                        ILcdBounds aBounds)
                 throws IOException
```
    Decode the specified file into a model. This can be either:
    - a properties file
    - a VPF feature table (point/line/area/text/complex)
    - a VPF database header table (dht)
    The following features will be included in the model.:
    - If a VPF database header table is used a source, all features of the VPF database will be decoded. The resulting model will be an instance of ILcdModelTreeNode. The model tree will have the same hierarchy as the VPF data. At the root level is the database node which contains a node for each available library. The library nodes contain the coverage nodes containing the feature class nodes.
    - If aBounds != null, only the feature within these bounds will be included.
    - Otherwise, if bounds are defined in the properties file, only the features within the specified bounds will be included.
    - Otherwise, if the decoding bounds set on this decoder are non-null, only the features within the decoding bounds will be included.
    - Otherwise, all features will be included.
    Parameters:
    
    aSourceName - source name specifying the properties file to be decoded.
    
    aBounds - bounds limiting the set of VPF features to be decoded.
    
    Returns:
    
    a model containing all features from the specified feature class within the limiting bounds, if specified.
    
    Throws:
    
    IOException - if an IO error occurs during the decoding.
  - decode
```
public ILcdModel decode(Properties aProperties)
                 throws IOException
```
    Retrieves the VPF feature class defined by this properties, and returns a model containing the features from this feature class. The following features will be included in the model.:
    - If bounds are defined in the properties, only the features within the specified bounds will be included.
    - Otherwise, if the decoding bounds set on this decoder are non-null, only the features within the decoding bounds will be included.
    - Otherwise, all features will be included.
    Parameters:
    
    aProperties - Properties object specifying the VPF feature class (and optionally bounds) for which to create and return a model.
    
    Returns:
    
    a model containing all features from the specified feature class within the limiting bounds, if specified.
    
    Throws:
    
    IOException - if an IO error occurs during the decoding.
  - decode
```
public ILcdModel decode(Properties aProperties,
                        ILcdBounds aBounds)
                 throws IOException
```
    Retrieves the VPF feature class defined by this properties file, and constructs a model containing the features from this feature class. The following features will be included in the model.:
    - If aBounds != null, only the feature within these bounds will be included.
    - Otherwise, if bounds are defined in the properties, only the features within the specified bounds will be included.
    - Otherwise, if the decoding bounds set on this decoder are non-null, only the features within the decoding bounds will be included.
    - Otherwise, all features will be included.
    Parameters:
    
    aProperties - Properties object specifying the VPF feature class (and optionally bounds) for which to create and return a model.
    
    aBounds - bounds limiting the set of VPF features to be decoded.
    
    Returns:
    
    a model containing all features from the specified feature class within the limiting bounds, if specified.
    
    Throws:
    
    IOException - if an IO error occurs during the decoding.
  - decode
```
public ILcdModel decode(TLcdVPFFeatureClass aFeatureClass)
                 throws IOException
```
    Returns a model containing the features from the specified feature class. The following features will be included in the model.:
    - If the decoding bounds set on this decoder are non-null, only the features within the decoding bounds will be included.
    - Otherwise, all features will be included.
    Parameters:
    
    aFeatureClass - VPF feature class for which to decode the features and return a model.
    
    Returns:
    
    a model containing all features from the specified feature class within the limiting bounds, if specified.
    
    Throws:
    
    IOException - if an IO error occurs during the decoding.
  - decode
```
public ILcdModel decode(TLcdVPFFeatureClass aFeatureClass,
                        ILcdBounds aBounds)
                 throws IOException
```
    Returns a model containing the features from the specified feature class. The following features will be included in the model.:
    - If aBounds != null, only the feature within these bounds will be included.
    - Otherwise, if bounds are defined in the properties, only the features within the specified bounds will be included.
    - Otherwise, if the decoding bounds set on this decoder are non-null, only the features within the decoding bounds will be included.
    - Otherwise, all features will be included.
    Parameters:
    
    aFeatureClass - VPF feature class for which to decode the features and return a model.
    
    aBounds - bounds limiting the set of VPF features to be decoded.
    
    Returns:
    
    a model containing all features from the specified feature class within the limiting bounds, if specified.
    
    Throws:
    
    IOException - if an IO error occurs during the decoding.
  - setMemoryUsage
```
public static void setMemoryUsage(int aUsage)
```
    Deprecated. Use the non-static setModelType method instead, to indicate whether the decoder should create full (fast, but high memory usage) or empty (slower, but lower memory usage) models.
    
    Use the non-static setModelType method instead.
    
    Parameters:
    
    aUsage - This argument is not used.
    
    See Also:
    
    getMemoryUsage(), setModelType(com.luciad.format.vpf.TLcdVPFModelDecoder.ModelType)
  - getMemoryUsage
```
public static int getMemoryUsage()
```
    Deprecated. Use the non-static getModelType method.
    
    Use the non-static getModelType method instead.
    
    Returns:
    
    The value, set by setMemoryUsage. This value is no longer used by VPF model decoder instances.
    
    See Also:
    
    setMemoryUsage(int), getModelType()
  - getThresholdForRegularTiledModel
```
public int getThresholdForRegularTiledModel()
```
    Deprecated. Don't use this method. This feature is not supported anymore.
    
    This feature is not supported anymore.
    
    Returns:
    
    This feature is not supported anymore.
    
    See Also:
    
    setThresholdForRegularTiledModel(int)
  - setThresholdForRegularTiledModel
```
public void setThresholdForRegularTiledModel(int aThresholdForRegularTiledModel)
```
    Deprecated. Don't use this method. This feature is not supported anymore.
    
    This feature is not supported anymore.
    
    Parameters:
    
    aThresholdForRegularTiledModel - This feature is not supported anymore.
    
    See Also:
    
    getThresholdForRegularTiledModel()
  - setClassTraceOn
```
public static void setClassTraceOn(boolean aClassTraceOn)
```
    Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
    
    Enables tracing for all instances of this class. If the argument is true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.
    
    Parameters:
    
    aClassTraceOn - if true then all log messages are recorded, otherwise only the informative, warning and error messages are recorded.
  - setTraceOn
```
public void setTraceOn(boolean aTraceOn)
```
    Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
    
    Enables tracing for this class instance. Calling this method with either true or false as argument automatically turns off tracing for all other class instances for which setTraceOn has not been called. If the argument is false then only the informative, warning and error log messages are recorded.
    
    Parameters:
    
    aTraceOn - if true then all log messages are recorded for this instance. If false, then only the informative, warning and error log messages are recorded.
  - isTraceOn
```
public boolean isTraceOn()
```
    Deprecated. This method has been deprecated. It is recommended to use the standard Java logging framework directly.
    
    Returns true if tracing is enabled for this class.
    
    Returns:
    
    true if tracing is enabled for this class, false otherwise.
  - setDeepTraceOn
```
public void setDeepTraceOn(boolean aDeepTraceOn)
```
    Enabled deep (detailed) logging on this object. This feature is currently not implemented anymore.
    
    Parameters:
    
    aDeepTraceOn - boolean indicating whether logging should be enabled for this object.
    
    See Also:
    
    isDeepTraceOn()
  - isDeepTraceOn
```
public boolean isDeepTraceOn()
```
    Returns whether deep (detailed) logging is enabled for this object.. This feature is currently not implemented anymore.
    
    Returns:
    
    true if deep (detailed) logging is enabled for this object, false otherwise.
    
    See Also:
    
    setDeepTraceOn(boolean)

Defense StandardsClass TLcdVPFModelDecoder

Input

Required files

Supported transfer protocols

Model structure

Model descriptor

Model reference

Model elements

Useful settings

Sample code

Performance tips

Thread safety

Supported versions and specifications

Known limitations

Requirements

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.luciad.model.ILcdModelDecoder

Field Detail

LUCIAD_PREFIX

DB_PATH

LIBRARY_NAME

COVERAGE_NAME

LINE

POINT

AREA

TEXT

COMPLEX

DISPLAY_NAME

SOURCE_NAME

LOWER_LEFT_X

LOWER_LEFT_Y

WIDTH

HEIGHT

REFERENCE

PROJECTION

GEODETIC

LOW_MEMORY

HIGH_MEMORY

Constructor Detail

TLcdVPFModelDecoder

TLcdVPFModelDecoder

Method Detail

setDecodingBounds

getDecodingBounds

setInputStreamFactory

getInputStreamFactory

setModelType

getModelType

getModelElementMode

setModelElementMode

setUseNullValues

isUseNullValues

getDefaultExtension

getDisplayName

canDecodeSource

decode

decode

decode

decode

decode

decode

setMemoryUsage

getMemoryUsage

getThresholdForRegularTiledModel

setThresholdForRegularTiledModel

setClassTraceOn

setTraceOn

isTraceOn

setDeepTraceOn

isDeepTraceOn