TLcdGML32File (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.datamodel.TLcdDataObject
- - com.luciad.format.gml32.model.TLcdGML32File

All Implemented Interfaces:

ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable
```
public class TLcdGML32File
extends TLcdDataObject
```
For efficiency reasons, GML also provides a means of encoding the range set in an arbitrary external encoding, such as a binary file. This encoding may be "well-known" but this is not required. This mode uses the gml:File element. The values of the coverage (attribute values in the range set) are transmitted in a external file that is referenced from the XML structure described by gml:FileType. The external file is referenced by the gml:fileReference property that is an anyURI (the gml:fileName property has been deprecated). This means that the external file may be located remotely from the referencing GML instance. The gml:compression property points to a definition of a compression algorithm through an anyURI. This may be a retrievable, computable definition or simply a reference to an unambiguous name for the compression method. The gml:mimeType property points to a definition of the file mime type. The gml:fileStructure property is defined by a codelist. Note further that all values shall be enclosed in a single file. Multi-file structures for values are not supported in GML. The semantics of the range set is described as above using the gml:rangeParameters property. Note that if any compression algorithm is applied, the structure above applies only to the pre-compression or post-decompression structure of the file. Note that the fields within a record match the gml:valueComponents of the gml:CompositeValue in document order.

Since:

2017.0

Field Summary

Fields
Modifier and Type	Field and Description
`static TLcdDataProperty`	`COMPRESSION_PROPERTY` Data property that maps to the `compression` element.
`static TLcdDataProperty`	`FILE_NAME_PROPERTY` Data property that maps to the `fileName` element.
`static TLcdDataProperty`	`FILE_REFERENCE_PROPERTY` Data property that maps to the `fileReference` element.
`static TLcdDataProperty`	`FILE_STRUCTURE_PROPERTY` Data property that maps to the `fileStructure` element.
`static TLcdDataProperty`	`MIME_TYPE_PROPERTY` Data property that maps to the `mimeType` element.
`static TLcdDataProperty`	`RANGE_PARAMETERS_PROPERTY` Data property that maps to the `rangeParameters` element.

Constructor Summary

Constructors
Constructor and Description

TLcdGML32File()

TLcdGML32File(TLcdDataType aType)

Constructors
Constructor and Description
`TLcdGML32File()`
`TLcdGML32File(TLcdDataType aType)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`URI`	`getCompression()` Returns the value of the property that maps to the `compression` element.
`URI`	`getFileName()` Returns the value of the property that maps to the `fileName` element.
`URI`	`getFileReference()` Returns the value of the property that maps to the `fileReference` element.
`TLcdGML32Code`	`getFileStructure()` Returns the value of the property that maps to the `fileStructure` element.
`URI`	`getMimeType()` Returns the value of the property that maps to the `mimeType` element.
`TLcdGML32AssociationRole`	`getRangeParameters()` Returns the value of the property that maps to the `rangeParameters` element.
`void`	`setCompression(URI aValue)` Sets the value of the property that maps to the `compression` element.
`void`	`setFileName(URI aValue)` Sets the value of the property that maps to the `fileName` element.
`void`	`setFileReference(URI aValue)` Sets the value of the property that maps to the `fileReference` element.
`void`	`setFileStructure(TLcdGML32Code aValue)` Sets the value of the property that maps to the `fileStructure` element.
`void`	`setMimeType(URI aValue)` Sets the value of the property that maps to the `mimeType` element.
`void`	`setRangeParameters(TLcdGML32AssociationRole aValue)` Sets the value of the property that maps to the `rangeParameters` element.

Methods inherited from class com.luciad.datamodel.TLcdDataObject
clone, clone, getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue, toString

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

- Field Detail
  - RANGE_PARAMETERS_PROPERTY
```
public static final TLcdDataProperty RANGE_PARAMETERS_PROPERTY
```
    Data property that maps to the rangeParameters element. The possible values for this property are instances of TLcdGML32AssociationRole.
  - FILE_NAME_PROPERTY
```
public static final TLcdDataProperty FILE_NAME_PROPERTY
```
    Data property that maps to the fileName element. The possible values for this property are instances of URI.
  - FILE_REFERENCE_PROPERTY
```
public static final TLcdDataProperty FILE_REFERENCE_PROPERTY
```
    Data property that maps to the fileReference element. The possible values for this property are instances of URI.
  - FILE_STRUCTURE_PROPERTY
```
public static final TLcdDataProperty FILE_STRUCTURE_PROPERTY
```
    Data property that maps to the fileStructure element. The possible values for this property are instances of TLcdGML32Code.
  - MIME_TYPE_PROPERTY
```
public static final TLcdDataProperty MIME_TYPE_PROPERTY
```
    Data property that maps to the mimeType element. The possible values for this property are instances of URI.
  - COMPRESSION_PROPERTY
```
public static final TLcdDataProperty COMPRESSION_PROPERTY
```
    Data property that maps to the compression element. The possible values for this property are instances of URI.
- Constructor Detail
  - TLcdGML32File
```
public TLcdGML32File()
```
  - TLcdGML32File
```
public TLcdGML32File(TLcdDataType aType)
```
- Method Detail
  - getRangeParameters
```
public TLcdGML32AssociationRole getRangeParameters()
```
    Returns the value of the property that maps to the rangeParameters element.
    
    Returns:
    
    the value of the RANGE_PARAMETERS_PROPERTY property.
  - setRangeParameters
```
public void setRangeParameters(TLcdGML32AssociationRole aValue)
```
    Sets the value of the property that maps to the rangeParameters element.
    
    Parameters:
    
    aValue - the value to set for the RANGE_PARAMETERS_PROPERTY property.
  - getFileName
```
public URI getFileName()
```
    Returns the value of the property that maps to the fileName element.
    
    Returns:
    
    the value of the FILE_NAME_PROPERTY property.
  - setFileName
```
public void setFileName(URI aValue)
```
    Sets the value of the property that maps to the fileName element.
    
    Parameters:
    
    aValue - the value to set for the FILE_NAME_PROPERTY property.
  - getFileReference
```
public URI getFileReference()
```
    Returns the value of the property that maps to the fileReference element.
    
    Returns:
    
    the value of the FILE_REFERENCE_PROPERTY property.
  - setFileReference
```
public void setFileReference(URI aValue)
```
    Sets the value of the property that maps to the fileReference element.
    
    Parameters:
    
    aValue - the value to set for the FILE_REFERENCE_PROPERTY property.
  - getFileStructure
```
public TLcdGML32Code getFileStructure()
```
    Returns the value of the property that maps to the fileStructure element.
    
    Returns:
    
    the value of the FILE_STRUCTURE_PROPERTY property.
  - setFileStructure
```
public void setFileStructure(TLcdGML32Code aValue)
```
    Sets the value of the property that maps to the fileStructure element.
    
    Parameters:
    
    aValue - the value to set for the FILE_STRUCTURE_PROPERTY property.
  - getMimeType
```
public URI getMimeType()
```
    Returns the value of the property that maps to the mimeType element.
    
    Returns:
    
    the value of the MIME_TYPE_PROPERTY property.
  - setMimeType
```
public void setMimeType(URI aValue)
```
    Sets the value of the property that maps to the mimeType element.
    
    Parameters:
    
    aValue - the value to set for the MIME_TYPE_PROPERTY property.
  - getCompression
```
public URI getCompression()
```
    Returns the value of the property that maps to the compression element.
    
    Returns:
    
    the value of the COMPRESSION_PROPERTY property.
  - setCompression
```
public void setCompression(URI aValue)
```
    Sets the value of the property that maps to the compression element.
    
    Parameters:
    
    aValue - the value to set for the COMPRESSION_PROPERTY property.

LuciadLightspeedClass TLcdGML32File

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.luciad.datamodel.TLcdDataObject

Methods inherited from class java.lang.Object

Field Detail

RANGE_PARAMETERS_PROPERTY

FILE_NAME_PROPERTY

FILE_REFERENCE_PROPERTY

FILE_STRUCTURE_PROPERTY

MIME_TYPE_PROPERTY

COMPRESSION_PROPERTY

Constructor Detail

TLcdGML32File

TLcdGML32File

Method Detail

getRangeParameters

setRangeParameters

getFileName

setFileName

getFileReference

setFileReference

getFileStructure

setFileStructure

getMimeType

setMimeType

getCompression

setCompression