Package com.luciad.format.s57

Class TLcdS57CatalogueDataSource.Builder<B extends TLcdS57CatalogueDataSource.Builder<B>>

java.lang.Object

com.luciad.format.s57.TLcdS57CatalogueDataSource.Builder<B>

Enclosing class:

TLcdS57CatalogueDataSource

public static class TLcdS57CatalogueDataSource.Builder<B extends TLcdS57CatalogueDataSource.Builder<B>>
extends Object

A builder for creating TLcdS57CatalogueDataSource data sources.

Use TLcdS57CatalogueDataSource.newBuilder() to create an instance of this class.

Since:

2014.0

Method Summary

Modifier and Type	Method	Description
B	addCatalogue(String aSource)	Adds the given catalogue source to the list of catalogue sources in this data source.
B	addCatalogues(String... aCatalogueSources)	Adds the given catalogue sources to the list of catalogue sources in this data source.
B	addCell(String aCellSource)	Adds the given cell source to the list of cell sources in this data source.
B	addCells(String... aCellSources)	Adds the given cell sources to the list of cell sources in this data source.
TLcdS57CatalogueDataSource	build()	Builds the TLcdS57CatalogueDataSource.
B	id(String aId)	Sets an (optional) unique identifier of this catalogue data source.

Methods inherited from class java.lang.Object

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

Method Details

build

public TLcdS57CatalogueDataSource build()

Builds the TLcdS57CatalogueDataSource.

Returns:

the new TLcdS57CatalogueDataSource

id

public B id(String aId)

Sets an (optional) unique identifier of this catalogue data source.

The id can be any string consisting of alphanumeric characters (a-zA-Z0-9). The id is not required, but SENC caching will only work if the data source has an id. For the cache to work correctly, the id should be unique for this data set and should remain constant over time.

Parameters:

aId - a unique identifier for this catalogue ate source.

addCatalogue

public B addCatalogue(String aSource)

Adds the given catalogue source to the list of catalogue sources in this data source. The source should be a valid S-57 catalogue file ('CATALOG.031').

Parameters:

aSource - the source of an S-57 catalogue to be decoded as part of this data source.

addCatalogues

public B addCatalogues(String... aCatalogueSources)

Adds the given catalogue sources to the list of catalogue sources in this data source. The source should be a valid S-57 catalogue file ('CATALOG.031').

Parameters:

aCatalogueSources - the sources of S-57 catalogues to be decoded as part of this data source.

Since:

2017.0

addCell

public B addCell(String aCellSource)

Adds the given cell source to the list of cell sources in this data source. The source should be a valid S-57 cell base or update file (with .000, .001, .002, ... extension). Updates which are located next to the cell base file are not picked automatically - each update file needs to be added explicitly.

Parameters:

aCellSource - the source of the S-57 cell base or update file to be decoded as part of this data source.

addCells

public B addCells(String... aCellSources)

Adds the given cell sources to the list of cell sources in this data source. The source should be valid S-57 cells base or update files (with .000, .001, .002, ... extension). Updates which are located next to the cell base file are not picked automatically - each update file needs to be added explicitly.

Parameters:

aCellSources - the source of the S-57 cell base or update file to be decoded as part of this data source.

Since:

2017.0