nl.pdok.catalog

Interface Catalog

All Known Implementing Classes:

FileSystemCatalog

public interface Catalog

Method Summary

Methods

Modifier and Type	Method and Description
String	checkCatalogusBranch()
boolean	checkout(String gitAddress, String branchName, String authorization) Download and unpack the Catalogus from git.
boolean	datasetExists(String datasetName)
InputStream	getCsvResource(String datasetName, String fileName)
Path	getDatasetLocationShapesToDB(String datasetName)
Path	getDatasetLocationShapesToFeatured(String datasetName)
Path	getDatasetLocationTemplatesPath(String dataset)
Path	getDatasetLocationTest(String datasetName)
Path	getDatasetLocationTestData(String datasetName)
Path	getDatasetLocationTestExpected(String datasetName)
Collection<String>	getDatasetNames()
String	getDatasetNameVersioned(String datasetName, long version)
List<TestData>	getDatasetTestData(String datasetName)
List<JobConfigurationDataset>	getDatastoresConfiguration(String datasetName)
InputStream	getDdlResource(String datasetName)
String	getEngineTransformJson(String datasetName, String defaultEngine)
ExtractConfiguration	getExtractConfiguration(String datasetName)
Set<String>	getExtractTypes(String datasetName)
ArrayList<FeaturedCollectionOptions>	getFeaturedOptions(String datasetName)
Set<FeatureTemplate>	getFeatureTemplates(String datasetName)
String	getGeoserverType(String datasetName)
InputStream	getMapProxyTemplate(String datasetName, String configFile)
InputStream	getResourcePrepareTestset(String datasetName, String resourceName)
String	getRootLocation()
String	getServiceName(String datasetName)
InputStream	getSqlResource(String datasetName, String fileName)
String	getTargetProjection(String datasetName)
File	getTemplateResource(String dataset, String format, String file, String subfolder)
TilingConfiguration	getTilingConfiguration(String datasetName)
List<Workbench>	getTransformers()
boolean	getUniqueVersions(String datasetName, boolean defaultEngine)
Set<String>	getVersionedSchemas(String datasetName, long version)
Workbench	getWorkbench(String datasetName, WorkbenchType type, String workbenchName)
List<Workbench>	getWorkbenches(String datasetName)
List<Workbench>	getWorkbenches(String datasetName, WorkbenchType type)
String	getXml2JsonMapping(String datasetName, String translator)
boolean	isCatalogusBranchPresent()
boolean	isVersioned(String datasetName)
GmlConverterConfig	retrieveGmlConverterConfigFromCatalogus(String datasetName) Extract the configuration file required for the GMLConverter
List<JobEntry>	retrieveJobEntriesByDataset(String dataset) Extract JobEntries from the Catalogus.
boolean	withGtPkMetadata(String datasetName)
boolean	withIndexes(String datasetName)

Method Detail

getRootLocation

String getRootLocation()

datasetExists

boolean datasetExists(String datasetName)

getDatasetNameVersioned

String getDatasetNameVersioned(String datasetName,
                             long version)

isVersioned

boolean isVersioned(String datasetName)

getDatasetNames

Collection<String> getDatasetNames()

getDatasetLocationTest

Path getDatasetLocationTest(String datasetName)

getDatasetLocationTestData

Path getDatasetLocationTestData(String datasetName)

getDatasetTestData

List<TestData> getDatasetTestData(String datasetName)

getDatasetLocationTestExpected

Path getDatasetLocationTestExpected(String datasetName)

getResourcePrepareTestset

InputStream getResourcePrepareTestset(String datasetName,
                                    String resourceName)
                                      throws IOException

Throws:

IOException

getDatasetLocationTemplatesPath

Path getDatasetLocationTemplatesPath(String dataset)

getTemplateResource

File getTemplateResource(String dataset,
                       String format,
                       String file,
                       String subfolder)

getDdlResource

InputStream getDdlResource(String datasetName)
                           throws IOException

Throws:

IOException

getSqlResource

InputStream getSqlResource(String datasetName,
                         String fileName)
                           throws IOException

Throws:

IOException

getCsvResource

InputStream getCsvResource(String datasetName,
                         String fileName)
                           throws IOException

Throws:

IOException

getDatastoresConfiguration

List<JobConfigurationDataset> getDatastoresConfiguration(String datasetName)

getServiceName

String getServiceName(String datasetName)

getGeoserverType

String getGeoserverType(String datasetName)

getTargetProjection

String getTargetProjection(String datasetName)

withIndexes

boolean withIndexes(String datasetName)

withGtPkMetadata

boolean withGtPkMetadata(String datasetName)

getVersionedSchemas

Set<String> getVersionedSchemas(String datasetName,
                              long version)

getTilingConfiguration

TilingConfiguration getTilingConfiguration(String datasetName)

getMapProxyTemplate

InputStream getMapProxyTemplate(String datasetName,
                              String configFile)
                                throws IOException

Throws:

IOException

getExtractConfiguration

ExtractConfiguration getExtractConfiguration(String datasetName)

getDatasetLocationShapesToDB

Path getDatasetLocationShapesToDB(String datasetName)

getDatasetLocationShapesToFeatured

Path getDatasetLocationShapesToFeatured(String datasetName)

getFeaturedOptions

ArrayList<FeaturedCollectionOptions> getFeaturedOptions(String datasetName)

getExtractTypes

Set<String> getExtractTypes(String datasetName)
                            throws IOException

Throws:

IOException

getFeatureTemplates

Set<FeatureTemplate> getFeatureTemplates(String datasetName)
                                         throws ConfigurationException

Throws:

ConfigurationException

getXml2JsonMapping

String getXml2JsonMapping(String datasetName,
                        String translator)
                          throws IOException

Throws:

IOException

getEngineTransformJson

String getEngineTransformJson(String datasetName,
                            String defaultEngine)
                              throws ConfigurationException

Throws:

ConfigurationException

getUniqueVersions

boolean getUniqueVersions(String datasetName,
                        boolean defaultEngine)
                          throws ConfigurationException

Throws:

ConfigurationException

getWorkbenches

List<Workbench> getWorkbenches(String datasetName)

getWorkbenches

List<Workbench> getWorkbenches(String datasetName,
                             WorkbenchType type)

getWorkbench

Workbench getWorkbench(String datasetName,
                     WorkbenchType type,
                     String workbenchName)

getTransformers

List<Workbench> getTransformers()

retrieveJobEntriesByDataset

List<JobEntry> retrieveJobEntriesByDataset(String dataset)
                                           throws FileReaderException

Extract JobEntries from the Catalogus.

Parameters:

dataset - Name of the dataset to be extracted.

Returns:

List of JobEntries.

Throws:

FileReaderException

retrieveGmlConverterConfigFromCatalogus

GmlConverterConfig retrieveGmlConverterConfigFromCatalogus(String datasetName)
                                                           throws FileReaderException

Extract the configuration file required for the GMLConverter

Parameters:

datasetName -

Returns:

configuration File

Throws:

FileReaderException

checkout

boolean checkout(String gitAddress,
               String branchName,
               String authorization)

Download and unpack the Catalogus from git.

Parameters:

branchName - Name of the branch to be downloaded.

authorization - Basic authorization for accessing the Git repository.

Returns:

true if the branch has been successfully downloaded and unpacked.

isCatalogusBranchPresent

boolean isCatalogusBranchPresent()

Returns:

true if a catalogus folder is present

checkCatalogusBranch

String checkCatalogusBranch()

Returns:

the catalogus Branch on the local hard drive