Class EmbeddedResources

Object

InstallationResources

EmbeddedResources

public class EmbeddedResources
extends InstallationResources

Provides an embedded database for the EPSG geodetic dataset and other resources. Provides also a copy of the EPSG terms of use, which should be accepted by users before the EPSG dataset can be installed.

Since:

0.8

See Also:

• https://epsg.org/

Constructor Summary

Constructors

Constructor	Description
Embedded­Resources()	Creates a new provider for connections to the embedded database.

Method Summary

Modifier and Type	Method	Description
Set<String>	get­Authorities()	Returns the pseudo-authority, which is "Embedded".
String	get­License(String authority, Locale locale, String mime­Type)	Returns the license of embedded data.
Data­Source	get­Resource(String authority, int index)	Returns the data source for embedded database.
String[]	get­Resource­Names(String authority)	Returns the data source name, which is "Spatial­Metadata".
Buffered­Reader	open­Script(String authority, int resource)	Unconditionally throws an exception since the embedded database is not provided as SQL scripts.

Methods inherited from class InstallationResources

get­Instruction­URL, load

Modifier and Type	Method	Description
String	get­Instruction­URL()	Returns a URL where users can get more information about the installation process.
static Service­Loader<Installation­Resources>	load()	Returns all installation resources found on the module path, regardless if supported or not.

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, to­String, wait, wait, wait

Constructor Details

EmbeddedResources

public EmbeddedResources()

Creates a new provider for connections to the embedded database.

Method Details

getAuthorities

public Set<String> getAuthorities()

Returns the pseudo-authority, which is "Embedded".

Specified by:

get­Authorities in class Installation­Resources

Returns:

"Embedded" pseudo-authority.

getLicense

public String getLicense(String authority,
 Locale locale,
 String mimeType)
                  throws IOException

Returns the license of embedded data.

Specified by:

get­License in class Installation­Resources

Parameters:

authority - shall be "Embedded".

locale - the preferred locale for the terms of use.

mime­Type - either "text/plain" or "text/html".

Returns:

the terms of use in plain text or HTML, or null if none.

Throws:

Illegal­Argument­Exception - if the given authority argument is not the expected values.

IOException - if an error occurred while reading the license file.

getResourceNames

public String[] getResourceNames(String authority)

Returns the data source name, which is "Spatial­Metadata".

Specified by:

get­Resource­Names in class Installation­Resources

Parameters:

authority - shall be "Embedded".

Returns:

"Spatial­Metadata".

getResource

public DataSource getResource(String authority,
 int index)

Returns the data source for embedded database. If the SIS_DATA environment variable is defined and does not contain Spatial­Metadata files, the embedded data will be copied in that directory and the returned Data­Source will use these files. This copy is done because database operations are faster on ordinary files compared to entries embedded in a JAR file.

Overrides:

get­Resource in class Installation­Resources

Parameters:

authority - shall be "Embedded".

index - shall be 0.

Returns:

the embedded data source, or null if not available.

See Also:

• Class­Loader.get­Resource(String)

openScript

public BufferedReader openScript(String authority,
 int resource)
                          throws IOException

Unconditionally throws an exception since the embedded database is not provided as SQL scripts.

Specified by:

open­Script in class Installation­Resources

Parameters:

authority - shall be "Embedded".

resource - shall be 0.

Returns:

never return.

Throws:

IOException - always thrown.