com.toolsverse.etl.metadata

Class FileMetadata

Object

com.toolsverse.etl.metadata.BaseMetadata

com.toolsverse.etl.metadata.FileMetadata

All Implemented Interfaces:

Metadata, ExtensionModule, Comparable<ExtensionModule>

Direct Known Subclasses:

ClobFileMetadata, DefaultFileMetadata, ExcelFileMetadata, ExcelXlsxFileMetadata, JsonDatasetMetadata, JsonMetadata, KeyValueFileMetadata, TextFileMetadata, XmlFileMetadata, XmlObjectFileMetadata

public abstract class FileMetadata
extends BaseMetadata

The abstract implementation of Metadata interface for the file based data sources such as text file, xml file, Excel, etc.

Since:

2.0

Version:

2.0

Field Summary

Fields inherited from class com.toolsverse.etl.metadata.BaseMetadata

TYPES_SUPPORT_REFRESH

Fields inherited from interface com.toolsverse.etl.metadata.Metadata

ALL_REFS, ALL_TYPES, BASE_CLASS_PATH, DB_DELIMITER, DEFAULT_METHOD, DEFAULT_TYPE, ID_FIELD, METADATA_DELIMITER, SYNONYMS_DATASET_TYPE, TABLE_PRIV, TABLE_PRIVS, TABLES_DATASET_TYPE, TYPE_ALIAS, TYPE_ALIASES, TYPE_ASSEMBLIES, TYPE_ASSEMBLY, TYPE_CATALOG, TYPE_CLASS, TYPE_COLUMN, TYPE_COLUMNS, TYPE_CONSTRAINTS, TYPE_DATA_SET, TYPE_DB_LINK, TYPE_DB_LINKS, TYPE_DBFUNCT, TYPE_DBFUNCTIONS, TYPE_DBINFO, TYPE_DBPROP, TYPE_DBPROPS, TYPE_DIRECTORIES, TYPE_DIRECTORY, TYPE_EK, TYPE_EK_COLUMN, TYPE_EK_COLUMNS, TYPE_EKS, TYPE_EXEC_METHOD, TYPE_EXEC_METHODS, TYPE_FILE, TYPE_FK, TYPE_FK_COLUMN, TYPE_FK_COLUMNS, TYPE_FKS, TYPE_FUNCT, TYPE_FUNCT_PARAMETERS, TYPE_FUNCTS, TYPE_GLOBAL_TEMPORARIES, TYPE_INDEX, TYPE_INDEX_COLUMN, TYPE_INDEX_COLUMNS, TYPE_INDEXES, TYPE_JAVA_CLASSES, TYPE_LOCAL_TEMPORARIES, TYPE_NICKNAME, TYPE_PACKAGE, TYPE_PACKAGE_BODY, TYPE_PACKAGES, TYPE_PARAMETER, TYPE_PARAMETERS, TYPE_PK, TYPE_PK_COLUMN, TYPE_PK_COLUMNS, TYPE_PKS, TYPE_PROC, TYPE_PROC_PARAMETERS, TYPE_PROCS, TYPE_PROCS_FUNCS, TYPE_QUEUE, TYPE_QUEUE_TABLE, TYPE_QUEUE_TABLES, TYPE_QUEUES, TYPE_RECYCLE_BIN, TYPE_RECYCLE_BIN_ITEM, TYPE_SCHEMA, TYPE_SEQUENCE, TYPE_SEQUENCES, TYPE_SYNONYM, TYPE_SYNONYMS, TYPE_SYSTEM_TABLES, TYPE_SYSTEM_VIEWS, TYPE_TABLE, TYPE_TABLES, TYPE_TEMPORARY_TABLES, TYPE_TEMPORARY_VIEWS, TYPE_TRIGGER, TYPE_TRIGGERS, TYPE_TYPE, TYPE_TYPES, TYPE_USER_TYPE, TYPE_USER_TYPES, TYPE_VIEW, TYPE_VIEWS, TYPE_WORKSHEET, TYPE_WORKSHEETS, TYPE_XML_SCHEMA, TYPE_XML_SCHEMAS, VIEWS_DATASET_TYPE

Fields inherited from interface com.toolsverse.ext.ExtensionModule

APP, COMMAND, ETL_DRIVER, FORMATTER, IDE_NODE, NO_RANK, WIDGET

Constructor Summary

Constructors

Constructor and Description
FileMetadata()

Method Summary

Modifier and Type	Method and Description
boolean	allowNotDefault() Checks if not default objects are allowed in the restricted mode.
String	createAsText(String sql, String catalog, String schema, String pattern, String type) Shows object create DDL.
Map<Integer,List<FieldDef>>	discoverDatabaseTypes() Discovers database types.
String	executeAsText(String catalog, String schema, String pattern, String type, String metadataId) Shows object execute SQL.
void	free() Free the resources.
String	getAllowedSchema() Gets the allowed schema when in restricted mode.
Set<String>	getCatalogSchemaMetadataAllowed() Gets the set of allowed database objects for catalogs and schemas when in restricted mode.
DataSet	getColumns(DataSet dataSet) Gets the columns.
String	getDataSetName(String catalog) Gets the data set name.
Map<String,String>	getMetadataMethods() Gets the metadata methods.
Set<String>	getTableMetadataAllowed() Gets the set of allowed database objects for tables when in restricted mode.
abstract DataSet	getTablesByType(InputStream inputSteam, String name, String pattern, String type) Gets the tables by type.
abstract DataSet	getTablesByType(String catalog, String schema, String pattern, String type) Gets the tables by type.
List<String>	getTableTypes() Gets the table types.
Set<String>	getTopLevelAllowed() Gets the set of allowed top level database objects when in restricted mode.
List<Object>	getTopLevelDbObjects() Gets the top level database objects.
String	getTypeByTypeFieldValue(String value) Gets the type by type field value.
String	getTypeField() Gets the type field.
Map<String,String>	getTypeMethods() Gets the type methods.
Map<String,String>	getTypesByParent() Gets the types by parent.
boolean	needToPopulate(String type) Checks if metadata node needs to be populatet.
boolean	supportsExecute(String type) Checks if metadata driver supports executeAsText method for the type.

Methods inherited from class com.toolsverse.etl.metadata.BaseMetadata

asText, compareTo, dropAsText, getColumns, getConfigFileName, getConnectionFactory, getConnectionParamsProvider, getCurrentDatabase, getDefaultColumns, getDisplayName, getDriver, getExtensionRank, getFullObjectName, getIconPath, getLocalUnitClassPath, getMetadataByType, getMetadataByTypePreserveException, getMetadataTypeByParentType, getMetadataTypes, getObjectName, getObjectOwnerName, getObjectTypes, getType, getXmlConfigFileName, hasCatalogs, hasMetadataTypes, hasSchemas, init, isDatabaseCurrent, searchDatabase, setCurrentDatabase, setHasCatalogs, setHasSchemas, supportsAsText, supportsDrop, supportsRefresh, supportsSearchDatabase

Methods inherited from class Object

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

Methods inherited from interface com.toolsverse.etl.metadata.Metadata

getName

Methods inherited from interface com.toolsverse.ext.ExtensionModule

getLicensePropertyName, getVendor, getVersion

Constructor Detail

FileMetadata

public FileMetadata()

Method Detail

allowNotDefault

public boolean allowNotDefault()

Description copied from interface: Metadata

Checks if not default objects are allowed in the restricted mode.

Returns:

true if not default objects are allowed in the restricted mode

createAsText

public String createAsText(String sql,
                           String catalog,
                           String schema,
                           String pattern,
                           String type)

Description copied from interface: Metadata

Shows object create DDL.

Parameters:

sql - the sql

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the string

discoverDatabaseTypes

public Map<Integer,List<FieldDef>> discoverDatabaseTypes()
                                                  throws Exception

Description copied from interface: Metadata

Discovers database types.

Returns:

the map of database types

Throws:

Exception - in case of any error

executeAsText

public String executeAsText(String catalog,
                            String schema,
                            String pattern,
                            String type,
                            String metadataId)
                     throws Exception

Description copied from interface: Metadata

Shows object execute SQL.

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

metadataId - the metadata id

Returns:

the string

Throws:

Exception - in case of any error

free

public void free()

Description copied from interface: Metadata

Free the resources.

getAllowedSchema

public String getAllowedSchema()

Description copied from interface: Metadata

Gets the allowed schema when in restricted mode.

Returns:

the allowed schema when in restricted mode.

getCatalogSchemaMetadataAllowed

public Set<String> getCatalogSchemaMetadataAllowed()

Description copied from interface: Metadata

Gets the set of allowed database objects for catalogs and schemas when in restricted mode.

Returns:

the set of allowed database objects for catalogs and schemas when in restricted mode

getColumns

public DataSet getColumns(DataSet dataSet)

Gets the columns.

Parameters:

dataSet - the data set

Returns:

the columns

getDataSetName

public String getDataSetName(String catalog)

Gets the data set name.

Parameters:

catalog - the catalog

Returns:

the data set name

getMetadataMethods

public Map<String,String> getMetadataMethods()

Description copied from class: BaseMetadata

Gets the metadata methods.

Specified by:

getMetadataMethods in class BaseMetadata

Returns:

the metadata methods

getTableMetadataAllowed

public Set<String> getTableMetadataAllowed()

Description copied from interface: Metadata

Gets the set of allowed database objects for tables when in restricted mode.

Returns:

the set of allowed database objects for tables when in restricted mode

getTablesByType

public abstract DataSet getTablesByType(InputStream inputSteam,
                                        String name,
                                        String pattern,
                                        String type)
                                 throws Exception

Gets the tables by type.

Parameters:

inputSteam - the input steam

name - the name

pattern - the pattern

type - the type

Returns:

the tables by type

Throws:

Exception - in case of any error

getTablesByType

public abstract DataSet getTablesByType(String catalog,
                                        String schema,
                                        String pattern,
                                        String type)
                                 throws Exception

Gets the tables by type.

Parameters:

catalog - the catalog

schema - the schema

pattern - the pattern

type - the type

Returns:

the tables by type

Throws:

Exception - in case of any error

getTableTypes

public List<String> getTableTypes()
                           throws Exception

Gets the table types.

Returns:

the table types

Throws:

Exception - in case of any error

getTopLevelAllowed

public Set<String> getTopLevelAllowed()

Description copied from interface: Metadata

Gets the set of allowed top level database objects when in restricted mode.

Returns:

the top level database objects

getTopLevelDbObjects

public List<Object> getTopLevelDbObjects()
                                  throws Exception

Description copied from interface: Metadata

Gets the top level database objects. Such as schemas etc.

Returns:

the top level database objects

Throws:

Exception - in case of any error

getTypeByTypeFieldValue

public String getTypeByTypeFieldValue(String value)

Description copied from interface: Metadata

Gets the type by type field value.

Parameters:

value - the value

Returns:

the type by type field value

getTypeField

public String getTypeField()

Description copied from interface: Metadata

Gets the type field.

Returns:

the type field

getTypeMethods

public Map<String,String> getTypeMethods()

Description copied from interface: Metadata

Gets the type methods.

Returns:

the type methods

getTypesByParent

public Map<String,String> getTypesByParent()

Description copied from class: BaseMetadata

Gets the types by parent.

Specified by:

getTypesByParent in class BaseMetadata

Returns:

the types by parent

needToPopulate

public boolean needToPopulate(String type)

Description copied from interface: Metadata

Checks if metadata node needs to be populatet.

Parameters:

type - the type

Returns:

true, if successful

supportsExecute

public boolean supportsExecute(String type)

Description copied from interface: Metadata

Checks if metadata driver supports executeAsText method for the type.

Parameters:

type - the type

Returns:

true, if successful