com.luciad.format.s57

Maritime StandardsClass TLcdS57CatalogueDataSource

java.lang.Object

com.luciad.format.s57.TLcdS57CatalogueDataSource

All Implemented Interfaces:

ILcdDataSource

public class TLcdS57CatalogueDataSource
extends java.lang.Object
implements ILcdDataSource

A data source for S-57 catalogues or virtual catalogues. It can be decoded by the com.luciad.format.s57.TLcdS57CatalogueModelDecoder.

This data source contains a list of one or more S-57 catalogue sources (CATALOG.031 files), and/or individual cell files (.000, .001, .002, ... files). In case of multiple catalogues and/or cells, the catalogues will be decoded as one virtual catalogue.

An optional id can be set on the data source; the id is used by the SENC cache as the unique identifier to refer to this data source.

This data source can also be used for catalogues/cells containing S-63 encrypted data. In that case it can be decoded by the com.luciad.format.s63.TLcdS63CatalogueModelDecoder or the com.luciad.format.s63.TLcdS63UnifiedModelDecoder.

Warning: it is not allowed to mix S-63 and S-57 data in the same TLcdS57CatalogueDataSource instance, nor is it allowed to mix data of different product types. The TLcdS57CatalogueDataSource will accept such a mix, but the model decoding will fail.

Since:

2014.0

See Also:

TLcdS57CatalogueModelDecoder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TLcdS57CatalogueDataSource.Builder<B extends TLcdS57CatalogueDataSource.Builder<B>> A builder for creating TLcdS57CatalogueDataSource data sources.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TLcdS57CatalogueDataSource(TLcdS57CatalogueDataSource.Builder aBuilder) Creates a new TLcdS57CatalogueDataSource based on the information in the Builder.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object aO)
java.util.List<java.lang.String>	getCatalogueSources() Returns all catalogue sources which are part of this data source.
java.util.List<java.lang.String>	getCellSources() Returns all cell sources which are part of this data source.
java.lang.String	getDescription() Returns a string description of the data source.
java.lang.String	getId() Returns the unique ID of this data source.
int	hashCode()
static TLcdS57CatalogueDataSource.Builder	newBuilder() Returns a new, empty builder for a TLcdS57CatalogueDataSource.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TLcdS57CatalogueDataSource

protected TLcdS57CatalogueDataSource(TLcdS57CatalogueDataSource.Builder aBuilder)

Creates a new TLcdS57CatalogueDataSource based on the information in the Builder.

This constructor is only here for subclasses. If you want to create a new TLcdS57CatalogueDataSource, you should call the TLcdS57CatalogueDataSource.Builder.build() method on a builder instance.

Parameters:

aBuilder - The builder

Method Detail

getId

public java.lang.String getId()

Returns the unique ID of this data source. This is used to identify the data source in the SENC cache.

Returns:

the unique ID of this data source

getCatalogueSources

public java.util.List<java.lang.String> getCatalogueSources()

Returns all catalogue sources which are part of this data source.

Returns:

all catalogue sources which are part of this data source.

See Also:

TLcdS57CatalogueDataSource.Builder.addCatalogue(String)

getCellSources

public java.util.List<java.lang.String> getCellSources()

Returns all cell sources which are part of this data source.

Returns:

all cell sources which are part of this data source.

See Also:

TLcdS57CatalogueDataSource.Builder.addCell(String)

getDescription

public java.lang.String getDescription()

Description copied from interface: ILcdDataSource

Returns a string description of the data source. This will typically be used in a GUI, or in error and warning messages.

Specified by:

getDescription in interface ILcdDataSource

Returns:

a String describing the data source.

equals

public boolean equals(java.lang.Object aO)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

newBuilder

public static TLcdS57CatalogueDataSource.Builder newBuilder()

Returns a new, empty builder for a TLcdS57CatalogueDataSource.

Returns:

a new, empty builder for a TLcdS57CatalogueDataSource.

Since:

2014.0