TLcdDGNModelDecoder (LuciadFusion API documentation)

java.lang.Object
- com.luciad.format.dgn.TLcdDGNModelDecoder

All Implemented Interfaces:: ILcdDGNModelDecoder, ILcdInputStreamFactoryCapable, ILcdModelDecoder

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

This model decoder decodes vector data in Intergraph Standard File Formats (ISFF). These file formats are common to Bentley's MicroStation and Intergraph's Interactive Graphics Design System.

Input files

File	Required	Entry point	Description
*.dgn	x	x	Design file (V7 or V8) containing vector data

Model reference

The model reference is obtained from an ILcdModelReferenceDecoder. The default reference decoder set on this model decoder is based on all model reference decoders annotated with the LcdService annotation, and can handle

EPSG references (<filename>.epsg): see TLcdEPSGModelReferenceDecoder for more info.
WKT references (<filename>.prj): see TLcdWKTModelReferenceDecoder for more info.
Luciad encoded model references (<filename>.ref): see TLcdModelReferenceDecoder for more info.

If this fails, the decoder's default model reference is returned. Unless set by the user, the default model reference is null.

Supported file transfer protocols

This model decoder supports currently only supports reading data from files.

Model structure

This model decoder creates a model per DGN file.
All models returned by this model decoder implement ILcd2DBoundsIndexedModel.
The models are expose any DGN tags through its data model. See further for more details.

Model descriptor

All models returned by this model decoder have a TLcdDGNModelDescriptor. Among other information, the descriptor contains the DGN symbology.
The type name of the model descriptor is the display name of this decoder.
The model descriptor returned by this model decoder is a TLcdDataModelDescriptor. Its data model exposes the DGN tags in a uniform way.

Model elements

Decoded models contain elements that all implement ILcdDGNShape.
All elements are ILcdDataObjects. If the element has any tags associated with it, the data object is a "TagSet" with property "Tags" that is a list of "AbstractTag" entities.

The following DGN elements are currently supported:

DGN element type	DGN element name	Decoded object
1	LIBRARY_CELL
2	CELL	`TLcdDGNCell`
3	LINE	`TLcdDGNLine2D`
4	LINE_STRING	`TLcdDGNLineString2D`
5	GROUP_DATA
6	SHAPE	`TLcdDGNShape2D`
7	TEXT_NODE	`TLcdDGNText2D`
9	DESIGN_SETTINGS
10	LEVEL_SYMBOLOGY
11	CURVE	`TLcdDGNCurve2D`
12	COMPLEX_CHAIN	`TLcdDGNComplexChain`
14	COMPLEX_SHAPE	`TLcdDGNComplexShape`
15	ELLIPSE	`TLcdDGNEllipse2D`
16	ARC	`TLcdDGNArc2D`
17	TEXT	`TLcdDGNText2D`
18	3D_SURFACE	`TLcdDGN3DSurface`
19	SOLID	`TLcdDGNSolid`
33	DIMENSION (note)	`TLcdDGNDimension`
34	SHARED_CELL_DEFINITION
35	SHARED_CELL_INSTANCE	`TLcdDGNCell`
36	CELL_MULTI_LINE	`TLcdDGNCell`
37	TAG_DATA

The following DGN elements that are not supported (basically splines, 3D surfaces, and rasters):

DGN element type	DGN element name
8	DIGITIZER_SETUP
13	CONIC
20	SUBFIGURE
21	B_SPLINE_CURVE
22	POINT_STRING
23	CONE
24	B_SPLINE_SURFACE
25	B_SPLINE_BOUNDARY
26	B_SPLINE_KNOT
27	B_SPLINE_WEIGHT
28	B_SPLINE
33	DIMENSION
66	APPLICATION
87	RASTER_HEADER
88	RASTER_DATA

Useful settings

By default, all element levels are decoded. You can restrict the decoding to the levels you are interested in, using the following methods:
If you have restricted the levels to be decoded, you can still specify additional levels based on their names, using the following methods:
By default, all element classes are decoded. You can restrict the decoding to the classes you are interested in, using the following methods:
By default, no MSLINK attributes are decoded. You can control the decoding of MSLINK attributes based on the database types you are interested in, using the following methods:
In addition, you will need to specify the entity numbers you are interested in, as described in the following paragraph.
By default, no database attributes (either MSLINK or DMRS) are decoded. You can control the decoding of database attributes based on the database entity numbers you are interested in, using the following methods:
By default, no tag attributes are decoded. You can control the decoding of tag attributes based on the tag set names, using the following methods:
All decoded element attributes can have a String containing a URL assigned to them, for the convenience of the application that uses the decoder:
- setDatabaseURL(String)
The implementation was highly modified in version 10.1. The pre-10.1 implementation is still available and can be activated using system property dgn.decoder.legacy=true.

Sample code


 ILcdModelDecoder decoder =
   new TLcdDGNNativeModelDecoder(new TLcdEPSGModelReferenceDecoder(),
                                 new TLcdGeodeticReference(new TLcdGeodeticDatum()));

 ILcdModel model = decoder.decode("vectordata.dgn");

Performance tips

By default, attributes are not decoded, potentially saving some memory and some processing time.

Thread safety

The decoding of models is not thread-safe.
The decoded models are thread-safe for read access.

Supported versions and specifications

DGN V7
DGN V8

Known limitations

The current implementation does not support splines, 3D surfaces, and rasters.
The current implementation will bypass the ILcdInputStreamFactory if the source is a regular file that can be read locally. If the source cannot be read locally (e.g. it is a URL) the source is copied to a local temp file before decoding, using the ILcdInputStreamFactory. Note that you can force the decoder to always use the input stream factory using system property dgn.decoder.alwaysuseinputstream=true.
The current implementation does not support user-defined fonts.
The symbology of the model elements corresponds to the first DGN view.

Constructor Summary

Constructors
Constructor and Description
`TLcdDGNModelDecoder()` Creates a new `TLcdDGNModelDecoder`.
`TLcdDGNModelDecoder(ILcdModelReference aDefaultModelReference)` Creates a new `TLcdDGNModelDecoder`.
`TLcdDGNModelDecoder(ILcdModelReferenceDecoder aModelReferenceDecoder)` Creates a new `TLcdDGNModelDecoder`.
`TLcdDGNModelDecoder(ILcdModelReferenceDecoder aModelReferenceDecoder, ILcdModelReference aDefaultModelReference)` Creates a new `TLcdDGNModelDecoder`.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAttributeEntity(int aEntity)` Adds an attribute entity number to the set of numbers that is decoded.
`void`	`addElementClass(int aElementClass)` Adds an element class to the list of element classes that is included into decoded models.
`void`	`addLevel(int aLevel)` Adds a level to the list of DGN levels that is included into all decoded models.
`void`	`addLevelName(String aLevelName)` Adds a name of a DGN level to the list of names of DGN levels that are to be included into all decoded models, in addition to the numeric level selection.
`void`	`addTagSet(String aTagSetName)` Adds a tag set name to the set of names that is decoded.
`void`	`addUserAttributeType(int aType)` Adds a DGN MSLINK attribute type to the set of types that is decoded.
`void`	`addUserAttributeType(String aType)` Adds a DGN MSLINK attribute type to the set of types that is decoded.
`boolean`	`canDecodeSource(String aSourceAsString)` Checks whether this model decoder can decode the specified data source.
`void`	`clearAttributeEntitySelection()` Clears the set of DGN database attributes that is decoded.
`void`	`clearLevelNameSelection()` Clears the list of names of DGN levels that are to be included into all decoded models.
`void`	`clearLevelSelection()` Clears the list of DGN levels that is included into decoded models.
`void`	`clearTagSetSelection()` Clears the set of DGN tag sets that is decoded.
`void`	`clearUserAttributeTypeSelection()` Clears the set of DGN MSLINK attributes that is decoded.
`void`	`clearUserDefinedFont(int aFontIndex)` Clears a user-defined font, so it will not be used in subsequently decoded models.
`ILcdModel`	`decode(String aSourceName)` Creates a new model from the given data source.
`int[]`	`getAttributeEntitySelection()`
`String`	`getDatabaseURL()`
`String`	`getDefaultExtension()`
`ILcdModelReference`	`getDefaultModelReference()`
`String`	`getDisplayName()` Returns a short, displayable name for the format that is decoded by this `ILcdModelDecoder`.
`int`	`getElementClassSelection()` Gets the the bitmask specifying list of element classes that is included into decoded models.
`ILcdInputStreamFactory`	`getInputStreamFactory()` Returns the input stream factory that is used.
`String[]`	`getLevelNameSelection()`
`long`	`getLevelSelection()` Deprecated. the returned value is limited to the first 64 levels. Starting with DGN version 8, this is no longer sufficient. Use `isLevelSelected(int)` or `getSelectedLevels()` instead.
`ILcdModelReference`	`getModelReference()` Deprecated. Use `getDefaultModelReference()`.
`ILcdModelReferenceDecoder`	`getModelReferenceDecoder()`
`int[]`	`getSelectedLevels()` Returns the array of selected levels.
`String[]`	`getTagSetSelection()`
`int[]`	`getUserAttributeTypeSelection()`
`boolean`	`isLevelSelected(int aLevel)` Returns true if the given level is selected, false otherwise.
`boolean`	`isUseFloat()`
`void`	`resetAttributeEntitySelection()` Resets the set of DGN database attributes that is decoded.
`void`	`resetElementClassSelection()` Resets the list of DGN element classes that is included into decoded models; As a result, all DGN element classes will be included in the models when decoding DGN files.
`void`	`resetLevelSelection()` Resets the list of DGN levels that is included into decoded models.
`void`	`resetTagSetSelection()` Resets the set of DGN tag sets that is decoded.
`void`	`resetUserAttributeTypeSelection()` Resets the set of DGN MSLINK attributes that is decoded.
`void`	`setAttributeEntitySelection(int[] aEntities)` Sets the set of DGN database attributes that is decoded.
`void`	`setDatabaseURL(String aDatabaseURL)` Sets the default database URL that is assigned to all decoded attributes.
`void`	`setDefaultModelReference(ILcdModelReference aDefaultModelReference)` Sets the default model reference for decoded models, in case the model reference decoder doesn't provide one.
`void`	`setElementClassSelection(int aElementClasses)` Sets the list of element classes that is included into decoded models.
`void`	`setElementClassSelection(int[] aElementClasses)` Sets the list of element classes that is included into decoded models.
`void`	`setInputStreamFactory(ILcdInputStreamFactory aInputStreamFactory)` Sets the input stream factory to be used.
`void`	`setLevelNameSelection(String[] aLevelNames)` Sets the list of names of DGN levels that are to be included into all decoded models, in addition to the numeric level selection.
`void`	`setLevelSelection(int[] aLevels)` Sets the list of DGN levels that is included into all decoded models.
`void`	`setLevelSelection(long aLevels)` Deprecated. this method is limited to the first 64 levels. Starting with DGN version 8, this is no longer sufficient. Use `setLevelSelection(long)` or `addLevel(int)` instead.
`void`	`setModelReference(ILcdModelReference aDefaultModelReference)` Deprecated. Use `setDefaultModelReference(ILcdModelReference)`.
`void`	`setModelReferenceDecoder(ILcdModelReferenceDecoder aModelReferenceDecoder)` Sets the model reference decoder that will be used for creating model references for decoded models.
`void`	`setTagSetSelection(String[] aTagSetNames)` Sets the set of DGN tag attributes that is decoded.
`void`	`setUseFloat(boolean aUseFloat)` Specifies whether to use memory-conserving floating point data structures for the decoded models.
`void`	`setUserAttributeTypeSelection(int[] aTypes)` Sets the set of DGN MSLINK attributes that is decoded.
`void`	`setUserAttributeTypeSelection(String[] aTypes)` Sets the set of DGN MSLINK attributes that is decoded.
`void`	`setUserDefinedFont(int aFontIndex, String aFontFileName)` Sets a user-defined font to be used in subsequently decoded models.

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

- Constructor Detail
  - TLcdDGNModelDecoder
```
public TLcdDGNModelDecoder()
```
    Creates a new TLcdDGNModelDecoder.
  - TLcdDGNModelDecoder
```
public TLcdDGNModelDecoder(ILcdModelReferenceDecoder aModelReferenceDecoder)
```
    Creates a new TLcdDGNModelDecoder.
    
    Parameters:
    
    aModelReferenceDecoder - the model reference decoder that can assign references to decoded models.
  - TLcdDGNModelDecoder
```
public TLcdDGNModelDecoder(ILcdModelReference aDefaultModelReference)
```
    Creates a new TLcdDGNModelDecoder.
    
    Parameters:
    
    aDefaultModelReference - the model reference that decoded models will get if the model reference decoder can't decode one.
  - TLcdDGNModelDecoder
```
public TLcdDGNModelDecoder(ILcdModelReferenceDecoder aModelReferenceDecoder,
                           ILcdModelReference aDefaultModelReference)
```
    Creates a new TLcdDGNModelDecoder.
    
    Parameters:
    
    aModelReferenceDecoder - the model reference decoder that can assign references to decoded models.
    
    aDefaultModelReference - the model reference that decoded models will get if the model reference decoder can't decode one.
- Method Detail
  - clearUserDefinedFont
```
public void clearUserDefinedFont(int aFontIndex)
```
    Clears a user-defined font, so it will not be used in subsequently decoded models.
    
    Parameters:
    
    aFontIndex - the index of the font, as used in the DGN files. The index must lie between 0 and 255.
  - setUserDefinedFont
```
public void setUserDefinedFont(int aFontIndex,
                               String aFontFileName)
                        throws IOException
```
    Sets a user-defined font to be used in subsequently decoded models.
    
    Parameters:
    
    aFontIndex - the index of the font, as used in the DGN files. The index must lie between 0 and 255.
    
    aFontFileName - the name of the cell definition file that defines the font. This file is typically produced using Bentley's FONTEXPT utility, which converts original RSC font files to CEL files.
    
    Throws:
    
    IOException
  - setInputStreamFactory
```
public void setInputStreamFactory(ILcdInputStreamFactory aInputStreamFactory)
```
    Description copied from interface: ILcdInputStreamFactoryCapable
    
    Sets the input stream factory to be used.
    
    Specified by:
    
    setInputStreamFactory in interface ILcdInputStreamFactoryCapable
    
    Parameters:
    
    aInputStreamFactory - the input stream factory to be used.
  - getInputStreamFactory
```
public ILcdInputStreamFactory getInputStreamFactory()
```
    Description copied from interface: ILcdInputStreamFactoryCapable
    
    Returns the input stream factory that is used.
    
    Specified by:
    
    getInputStreamFactory in interface ILcdInputStreamFactoryCapable
    
    Returns:
    
    the input stream factory that is used.
  - setModelReferenceDecoder
```
public void setModelReferenceDecoder(ILcdModelReferenceDecoder aModelReferenceDecoder)
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Sets the model reference decoder that will be used for creating model references for decoded models.
    
    Specified by:
    
    setModelReferenceDecoder in interface ILcdDGNModelDecoder
  - getModelReferenceDecoder
```
public ILcdModelReferenceDecoder getModelReferenceDecoder()
```
    Specified by:
    
    getModelReferenceDecoder in interface ILcdDGNModelDecoder
  - setDefaultModelReference
```
public void setDefaultModelReference(ILcdModelReference aDefaultModelReference)
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Sets the default model reference for decoded models, in case the model reference decoder doesn't provide one.
    
    Specified by:
    
    setDefaultModelReference in interface ILcdDGNModelDecoder
  - getDefaultModelReference
```
public ILcdModelReference getDefaultModelReference()
```
    Specified by:
    
    getDefaultModelReference in interface ILcdDGNModelDecoder
  - setModelReference
```
public void setModelReference(ILcdModelReference aDefaultModelReference)
```
    Deprecated. Use setDefaultModelReference(ILcdModelReference).
  - getModelReference
```
public ILcdModelReference getModelReference()
```
    Deprecated. Use getDefaultModelReference().
  - setDatabaseURL
```
public void setDatabaseURL(String aDatabaseURL)
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Sets the default database URL that is assigned to all decoded attributes. The URL can then be used by the application.
    
    Specified by:
    
    setDatabaseURL in interface ILcdDGNModelDecoder
  - getDatabaseURL
```
public String getDatabaseURL()
```
    Specified by:
    
    getDatabaseURL in interface ILcdDGNModelDecoder
  - setUseFloat
```
public void setUseFloat(boolean aUseFloat)
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Specifies whether to use memory-conserving floating point data structures for the decoded models.
    
    Specified by:
    
    setUseFloat in interface ILcdDGNModelDecoder
  - isUseFloat
```
public boolean isUseFloat()
```
    Specified by:
    
    isUseFloat in interface ILcdDGNModelDecoder
  - resetLevelSelection
```
public void resetLevelSelection()
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Resets the list of DGN levels that is included into decoded models. As a result, all DGN levels will be included in the models when decoding DGN files.
    
    Specified by:
    
    resetLevelSelection in interface ILcdDGNModelDecoder
  - clearLevelSelection
```
public void clearLevelSelection()
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Clears the list of DGN levels that is included into decoded models. As a result, only level 0 will be included in the models when decoding DGN files.
    
    Specified by:
    
    clearLevelSelection in interface ILcdDGNModelDecoder
    
    See Also:
    
    ILcdDGNModelDecoder.resetLevelSelection(), ILcdDGNModelDecoder.addLevel(int)
  - setLevelSelection
```
public void setLevelSelection(long aLevels)
```
    Deprecated. this method is limited to the first 64 levels. Starting with DGN version 8, this is no longer sufficient. Use setLevelSelection(long) or addLevel(int) instead.
    
    Sets the level selection mask.
    
    Parameters:
    
    aLevels - the level selection mask.
  - getLevelSelection
```
public long getLevelSelection()
```
    Deprecated. the returned value is limited to the first 64 levels. Starting with DGN version 8, this is no longer sufficient. Use isLevelSelected(int) or getSelectedLevels() instead.
    
    Returns the level selection mask.
    
    Returns:
    
    the level selection mask.
  - setLevelSelection
```
public void setLevelSelection(int[] aLevels)
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Sets the list of DGN levels that is included into all decoded models. Level 0 is always included, irrespective of the selection setting.
    
    Specified by:
    
    setLevelSelection in interface ILcdDGNModelDecoder
    
    Parameters:
    
    aLevels - the levels to be included in the decoded models. They can be listed in any order, and duplicate numbers are allowed.
  - addLevel
```
public void addLevel(int aLevel)
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Adds a level to the list of DGN levels that is included into all decoded models.
    
    Specified by:
    
    addLevel in interface ILcdDGNModelDecoder
    
    Parameters:
    
    aLevel - the level to be included in the decoded models.
  - clearLevelNameSelection
```
public void clearLevelNameSelection()
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Clears the list of names of DGN levels that are to be included into all decoded models. As a result, only levels specified in the numeric level selection will be included.
    
    Specified by:
    
    clearLevelNameSelection in interface ILcdDGNModelDecoder
    
    See Also:
    
    ILcdDGNModelDecoder.clearLevelSelection(), ILcdDGNModelDecoder.addLevelName(String)
  - setLevelNameSelection
```
public void setLevelNameSelection(String[] aLevelNames)
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Sets the list of names of DGN levels that are to be included into all decoded models, in addition to the numeric level selection.
    
    Specified by:
    
    setLevelNameSelection in interface ILcdDGNModelDecoder
    
    Parameters:
    
    aLevelNames - the names of levels to be included in the decoded models. They can be listed in any order, and duplicate names are allowed.
  - getLevelNameSelection
```
public String[] getLevelNameSelection()
```
  - addLevelName
```
public void addLevelName(String aLevelName)
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Adds a name of a DGN level to the list of names of DGN levels that are to be included into all decoded models, in addition to the numeric level selection.
    
    Specified by:
    
    addLevelName in interface ILcdDGNModelDecoder
    
    Parameters:
    
    aLevelName - the name of the level to be included in the decoded models.
  - resetElementClassSelection
```
public void resetElementClassSelection()
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Resets the list of DGN element classes that is included into decoded models; As a result, all DGN element classes will be included in the models when decoding DGN files.
    
    Specified by:
    
    resetElementClassSelection in interface ILcdDGNModelDecoder
  - setElementClassSelection
```
public void setElementClassSelection(int aElementClasses)
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Sets the list of element classes that is included into decoded models. This property allows to exclude certain classes from the decoded models, e.g. construction elements.
    Specified by:
    
    setElementClassSelection in interface ILcdDGNModelDecoder
    
    Parameters:
    aElementClasses - a bitmask, specifying the element classes to be included in the decoded models. It is a logical OR of 1-bits that are shifted left by the following constants:
    
    TLcdDGNDisplayInfo.CLASS_PRIMARY
    TLcdDGNDisplayInfo.CLASS_PATTERN
    TLcdDGNDisplayInfo.CLASS_CONSTRUCTION
    TLcdDGNDisplayInfo.CLASS_DIMENSION
    TLcdDGNDisplayInfo.CLASS_PRIMARY_RULE
    TLcdDGNDisplayInfo.CLASS_LINEAR_PATTERN
    TLcdDGNDisplayInfo.CLASS_CONSTRUCTION_RULE
  - getElementClassSelection
```
public int getElementClassSelection()
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Gets the the bitmask specifying list of element classes that is included into decoded models.
    
    Specified by:
    
    getElementClassSelection in interface ILcdDGNModelDecoder
  - setElementClassSelection
```
public void setElementClassSelection(int[] aElementClasses)
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Sets the list of element classes that is included into decoded models. This property allows to exclude certain classes from the decoded models, e.g. construction elements.
    Specified by:
    
    setElementClassSelection in interface ILcdDGNModelDecoder
    
    Parameters:
    aElementClasses - the element classes to be included in the decoded models. They can be listed in any order, and duplicate entries are allowed.
    The available DGN element classes are
    
    TLcdDGNDisplayInfo.CLASS_PRIMARY
    TLcdDGNDisplayInfo.CLASS_PATTERN
    TLcdDGNDisplayInfo.CLASS_CONSTRUCTION
    TLcdDGNDisplayInfo.CLASS_DIMENSION
    TLcdDGNDisplayInfo.CLASS_PRIMARY_RULE
    TLcdDGNDisplayInfo.CLASS_LINEAR_PATTERN
    TLcdDGNDisplayInfo.CLASS_CONSTRUCTION_RULE
    See Also:
    
    ILcdDGNModelDecoder.setElementClassSelection(int)
  - addElementClass
```
public void addElementClass(int aElementClass)
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Adds an element class to the list of element classes that is included into decoded models. This property allows to exclude certain classes from the decoded models, e.g. construction elements.
    Specified by:
    
    addElementClass in interface ILcdDGNModelDecoder
    
    Parameters:
    aElementClass - the element class to be included in the decoded models.
    The available DGN element classes are
    
    TLcdDGNDisplayInfo.CLASS_PRIMARY
    TLcdDGNDisplayInfo.CLASS_PATTERN
    TLcdDGNDisplayInfo.CLASS_CONSTRUCTION
    TLcdDGNDisplayInfo.CLASS_DIMENSION
    TLcdDGNDisplayInfo.CLASS_PRIMARY_RULE
    TLcdDGNDisplayInfo.CLASS_LINEAR_PATTERN
    TLcdDGNDisplayInfo.CLASS_CONSTRUCTION_RULE
  - resetUserAttributeTypeSelection
```
public void resetUserAttributeTypeSelection()
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Resets the set of DGN MSLINK attributes that is decoded. All MSLINK attributes will now be included in the models when decoding DGN files.
    
    Specified by:
    
    resetUserAttributeTypeSelection in interface ILcdDGNModelDecoder
    
    See Also:
    
    ILcdDGNModelDecoder.clearUserAttributeTypeSelection()
  - clearUserAttributeTypeSelection
```
public void clearUserAttributeTypeSelection()
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Clears the set of DGN MSLINK attributes that is decoded. None of the MSLINK attributes will now be included in the models when decoding DGN files.
    
    Specified by:
    
    clearUserAttributeTypeSelection in interface ILcdDGNModelDecoder
    
    See Also:
    
    ILcdDGNModelDecoder.resetUserAttributeTypeSelection(), ILcdDGNModelDecoder.addUserAttributeType(java.lang.String), ILcdDGNModelDecoder.addUserAttributeType(int)
  - setUserAttributeTypeSelection
```
public void setUserAttributeTypeSelection(String[] aTypes)
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Sets the set of DGN MSLINK attributes that is decoded. Only MSLINK attributes with the specified types will now be included in the models when decoding DGN files.
    Note that the attribute entities to be decoded have to be specified as well, using the addAttributeEntity method.
    
    Specified by:
    
    setUserAttributeTypeSelection in interface ILcdDGNModelDecoder
    
    Parameters:
    
    aTypes - a list of MSLINK attribute types, specified as numbers in RAD50 format (strings of length 3, e.g. "ODB"). Note that RAD50 is actually radix 40, with the following 40 digits: <space> A...Z $ . 0...9
  - setUserAttributeTypeSelection
```
public void setUserAttributeTypeSelection(int[] aTypes)
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Sets the set of DGN MSLINK attributes that is decoded. Only MSLINK attributes with the specified types will now be included in the models when decoding DGN files.
    
    Specified by:
    
    setUserAttributeTypeSelection in interface ILcdDGNModelDecoder
    
    Parameters:
    
    aTypes - a list of MSLINK attribute types, specified as integers (unsigned shorts, e.g. 0x5e62, which corresponds to 'ODB' in radix 50).
    
    See Also:
    
    ILcdDGNUserAttribute
  - getUserAttributeTypeSelection
```
public int[] getUserAttributeTypeSelection()
```
  - addUserAttributeType
```
public void addUserAttributeType(String aType)
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Adds a DGN MSLINK attribute type to the set of types that is decoded.
    
    Specified by:
    
    addUserAttributeType in interface ILcdDGNModelDecoder
    
    Parameters:
    
    aType - an MSLINK attribute type specified as a number in RAD50 format (a string of length 3, e.g. "ODB"). Note that RAD50 is actually radix 40, with the following 40 digits: <space> A...Z $ . 0...9
    
    See Also:
    
    ILcdDGNModelDecoder.addUserAttributeType(int)
  - addUserAttributeType
```
public void addUserAttributeType(int aType)
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Adds a DGN MSLINK attribute type to the set of types that is decoded. Only MSLINK attributes that have types in this set are decoded.
    Note that the attribute entities to be decoded have to be specified as well, using the addAttributeEntity method.
    
    Specified by:
    
    addUserAttributeType in interface ILcdDGNModelDecoder
    
    Parameters:
    
    aType - an MSLINK attribute type specified as an integer (an unsigned short, e.g. 0x5e62, which corresponds to 'ODB' in radix 50).
    
    See Also:
    
    ILcdDGNModelDecoder.addUserAttributeType(java.lang.String), ILcdDGNUserAttribute
  - resetAttributeEntitySelection
```
public void resetAttributeEntitySelection()
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Resets the set of DGN database attributes that is decoded. All DGN database attributes will now be included in the models when decoding DGN files.
    
    Specified by:
    
    resetAttributeEntitySelection in interface ILcdDGNModelDecoder
    
    See Also:
    
    ILcdDGNModelDecoder.clearAttributeEntitySelection()
  - clearAttributeEntitySelection
```
public void clearAttributeEntitySelection()
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Clears the set of DGN database attributes that is decoded. None of the DGN database attributes will now be included in the models when decoding DGN files.
    
    Specified by:
    
    clearAttributeEntitySelection in interface ILcdDGNModelDecoder
    
    See Also:
    
    ILcdDGNModelDecoder.resetAttributeEntitySelection(), ILcdDGNModelDecoder.addAttributeEntity(int)
  - setAttributeEntitySelection
```
public void setAttributeEntitySelection(int[] aEntities)
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Sets the set of DGN database attributes that is decoded. Only DGN database attributes with the specified entity numbers will now be included in the models when decoding DGN files.
    
    Specified by:
    
    setAttributeEntitySelection in interface ILcdDGNModelDecoder
    
    Parameters:
    
    aEntities - a list of entity numbers of database attributes (user or non-user).
  - getAttributeEntitySelection
```
public int[] getAttributeEntitySelection()
```
  - addAttributeEntity
```
public void addAttributeEntity(int aEntity)
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Adds an attribute entity number to the set of numbers that is decoded. Only attributes that have entity numbers in this set are decoded.
    Note that, for decoding user attributes, the user attribute types to be decoded have to be specified as well, using the addUserAttributeType method.
    Also note that the fill color, which is also stored as an element attribute, is an exception: it is always decoded as part of the display info.
    
    Specified by:
    
    addAttributeEntity in interface ILcdDGNModelDecoder
    
    Parameters:
    
    aEntity - an entity number of an database attribute (user or non-user).
  - resetTagSetSelection
```
public void resetTagSetSelection()
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Resets the set of DGN tag sets that is decoded. All tag sets and their attributes will now be included in the models when decoding DGN files.
    
    Specified by:
    
    resetTagSetSelection in interface ILcdDGNModelDecoder
    
    See Also:
    
    ILcdDGNModelDecoder.clearTagSetSelection()
  - clearTagSetSelection
```
public void clearTagSetSelection()
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Clears the set of DGN tag sets that is decoded. None of the tag sets will now be included in the models when decoding DGN files.
    
    Specified by:
    
    clearTagSetSelection in interface ILcdDGNModelDecoder
    
    See Also:
    
    ILcdDGNModelDecoder.resetTagSetSelection(), ILcdDGNModelDecoder.addTagSet(java.lang.String)
  - setTagSetSelection
```
public void setTagSetSelection(String[] aTagSetNames)
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Sets the set of DGN tag attributes that is decoded. Only the specified tag sets and their attributes will now be included in the models when decoding DGN files.
    
    Specified by:
    
    setTagSetSelection in interface ILcdDGNModelDecoder
    
    Parameters:
    
    aTagSetNames - a list of tag set names.
  - getTagSetSelection
```
public String[] getTagSetSelection()
```
  - addTagSet
```
public void addTagSet(String aTagSetName)
```
    Description copied from interface: ILcdDGNModelDecoder
    
    Adds a tag set name to the set of names that is decoded. Only the specified tag sets and their attributes will now be included in the models when decoding DGN files.
    
    Specified by:
    
    addTagSet in interface ILcdDGNModelDecoder
    
    Parameters:
    
    aTagSetName - a tag set name.
  - getDefaultExtension
```
public String getDefaultExtension()
```
    Returns:
    
    "dgn".
  - getSelectedLevels
```
public int[] getSelectedLevels()
```
    Returns the array of selected levels. If the levels are not filtered (all levels are selected), the function returns null.
    
    Returns:
    
    the array of selected levels, or null if all levels are selected.
  - isLevelSelected
```
public boolean isLevelSelected(int aLevel)
```
    Returns true if the given level is selected, false otherwise.
    
    Parameters:
    
    aLevel - the level to check
    
    Returns:
    
    true if the given level is selected, false otherwise.
  - 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:
    
    "DGN".
  - canDecodeSource
```
public boolean canDecodeSource(String aSourceAsString)
```
    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:
    
    aSourceAsString - the data source to be verified; typically a file name or a URL.
    
    Returns:
    
    true if the file extension is <defaultExtension> or <defaultExtension>.gz, <code>false</code> otherwise (<defaultExtension> is the String returned by getDefaultExtension).
    
    See Also:
    
    ILcdModelDecoder.decode(String), ILcdModelDecoder.decodeModelMetadata(String)
  - decode
```
public ILcdModel decode(String aSourceName)
                 throws IOException
```
    Description copied from interface: ILcdModelDecoder
    
    Creates a new model from the given data source.
    Specified by:
    
    decode in interface ILcdModelDecoder
    
    Parameters:
    
    aSourceName - the data source to be decoded; typically a file name or a URL.
    
    Returns:
    
    A model containing the decoded data. While null is allowed, implementors are advised to throw an error instead.
    
    Throws:
    IOException - for any exceptions caused by IO problems or invalid data. Since decoding invalid data almost always results in RunTimeExceptions (NullPointerException, IndexOutOfBoundsException, IllegalArgumentException, ...) on unexpected places, implementations are advised to catch RuntimeExceptions in their decode() method, and wrap them into an IOException, as illustrated in the code snippet below.
    public ILcdModel decode( String aSourceName ) throws IOException { try (InputStream input = fInputStreamFactory.createInputStream(aSourceName)) { // Perform decoding ... } catch (RuntimeException e) { throw new IOException(e); } }
    InterruptedIOException - When the thread on which this method is called is interrupted: it is recommended to stop the decoding and throw an InterruptedIOException. This same exception can also be used if the decoder shows UI to the user, and the user cancels the decoding through the UI.
    
    See Also:
    
    ILcdModelDecoder.canDecodeSource(String)

Infrastructure StandardsClass TLcdDGNModelDecoder

Input files

Model reference

Supported file transfer protocols

Model structure

Model descriptor

Model elements

Useful settings

Sample code

Performance tips

Thread safety

Supported versions and specifications

Known limitations

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.luciad.model.ILcdModelDecoder

Constructor Detail

TLcdDGNModelDecoder

TLcdDGNModelDecoder

TLcdDGNModelDecoder

TLcdDGNModelDecoder

Method Detail

clearUserDefinedFont

setUserDefinedFont

setInputStreamFactory

getInputStreamFactory

setModelReferenceDecoder

getModelReferenceDecoder

setDefaultModelReference

getDefaultModelReference

setModelReference

getModelReference

setDatabaseURL

getDatabaseURL

setUseFloat

isUseFloat

resetLevelSelection

clearLevelSelection

setLevelSelection

getLevelSelection

setLevelSelection

addLevel

clearLevelNameSelection

setLevelNameSelection

getLevelNameSelection

addLevelName

resetElementClassSelection

setElementClassSelection

getElementClassSelection

setElementClassSelection

addElementClass

resetUserAttributeTypeSelection

clearUserAttributeTypeSelection

setUserAttributeTypeSelection

setUserAttributeTypeSelection

getUserAttributeTypeSelection

addUserAttributeType

addUserAttributeType

resetAttributeEntitySelection

clearAttributeEntitySelection

setAttributeEntitySelection

getAttributeEntitySelection

addAttributeEntity

resetTagSetSelection

clearTagSetSelection

setTagSetSelection

getTagSetSelection

addTagSet

getDefaultExtension

getSelectedLevels

isLevelSelected

getDisplayName

canDecodeSource

decode