public final class BigDataAccessParameterMetadata
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
BigDataAccessParameterMetadata.TemplateValue
Object to represent the template of the default value for a specific
access parameter.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ADDITIONAL
Not a parameter name, but the prefix for any additional parameter that
is specific to a given access driver that isn't built in to the big
data support.
|
static java.lang.String |
CLASS
Parameter name "com.oracle.bigdata.class"
|
static java.lang.String |
CLUSTER
Parameter name "com.oracle.bigdata.cluster"
|
static java.lang.String |
COLMAP
Parameter name "com.oracle.bigdata.colmap"
|
static java.lang.String |
DATAMODE
Parameter name "com.oracle.bigdata.datamode"
|
static java.lang.String |
DATEMASK
Parameter name "com.oracle.bigdata.datemask"
|
static java.lang.String |
ERROROPT
Parameter name "com.oracle.bigdata.erroropt"
|
static java.lang.String |
FIELDCOUNT
Parameter name "com.oracle.bigdata.fieldcount"
|
static java.lang.String |
FIELDS
Parameter name "com.oracle.bigdata.fields"
|
static java.lang.String |
FILEFORMAT
Parameter name "com.oracle.bigdata.fileformat"
|
static java.lang.String |
LOG_EXEC
Parameter name "com.oracle.bigdata.log.exec"
|
static java.lang.String |
LOG_OPT
Parameter name "com.oracle.bigdata.log.opt"
|
static java.lang.String |
LOG_QC
Parameter name "com.oracle.bigdata.log.qc"
|
static java.lang.String |
MAXLEN
Parameter name "com.oracle.bigdata.maxlen"
|
static java.lang.String |
OVERFLOW
Parameter name "com.oracle.bigdata.overflow"
|
static java.lang.String |
ROWFORMAT
Parameter name "com.oracle.bigdata.rowformat"
|
static java.lang.String |
TABLENAME
Parameter name "com.oracle.bigdata.tablename"
|
static java.lang.String |
TBLPROPERTIES
Parameter name "com.oracle.bigdata.tblproperties"
|
Constructor and Description |
---|
BigDataAccessParameterMetadata() |
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
checkLineBreaks(java.lang.String str)
Checks that any line break in the given String is escaped by a
backslash.
|
static java.util.Collection<java.lang.String> |
getAllowedParameterNames(java.lang.String driver)
Gets the allow parameter names for the given driver.
|
static java.util.List<java.lang.String> |
getAllowedParameterValues(java.lang.String paramName,
Relation relation,
DBObjectProvider pro)
Gets the allowed values for the given parameter name.
|
static BigDataAccessParameterMetadata.TemplateValue |
getParameterTemplateValue(java.lang.String paramName)
Gets a template value for the given big data access parameter name.
|
static boolean |
hasAllowedParameterValues(java.lang.String paramName,
Relation relation,
DBObjectProvider pro)
Tests whether the given named parameter has listable allowed values.
|
static boolean |
isAdditionalAccessParameter(java.lang.String name)
All known parameters names for the BIG DATA drivers are listed by
getAllowedParameterNames(String) . |
static boolean |
isBigDataAccessDriver(java.lang.String driver)
Tests whether the given access driver is a "Big Data" access driver.
|
static boolean |
isLocationParameter(java.lang.String paramName)
Tests whether the given parameter's value is a "location" format - i.e.
|
static java.lang.String |
stripLineEscapes(java.lang.String str)
The parameter value can contain newlines but they must be escaped by a
\.
|
public static final java.lang.String ADDITIONAL
public static final java.lang.String TABLENAME
public static final java.lang.String FIELDCOUNT
public static final java.lang.String FIELDS
public static final java.lang.String FILEFORMAT
public static final java.lang.String ROWFORMAT
public static final java.lang.String CLASS
public static final java.lang.String COLMAP
public static final java.lang.String CLUSTER
public static final java.lang.String DATEMASK
public static final java.lang.String ERROROPT
public static final java.lang.String LOG_EXEC
public static final java.lang.String LOG_OPT
public static final java.lang.String LOG_QC
public static final java.lang.String MAXLEN
public static final java.lang.String OVERFLOW
public static final java.lang.String TBLPROPERTIES
public static final java.lang.String DATAMODE
public static java.lang.String stripLineEscapes(java.lang.String str)
value
- the value to strip the escapes from any newlinescheckLineBreaks(String)
public static java.lang.String checkLineBreaks(java.lang.String str)
This is not an escape function - a proper escape function would escape all existing backslashes as well. This is used to ensure that a given access parameter name or value will not produce invalid DDL because of extra newlines.
str
- the String to checkpublic static boolean isBigDataAccessDriver(java.lang.String driver)
driver
- the access driver name to testBigDataAccessParameters
public static boolean isAdditionalAccessParameter(java.lang.String name)
getAllowedParameterNames(String)
. The BIG DATA layer allowed
additional (unknown) parameters to be defined as long as they are in
the format com.oracle.bigdata.ad.<tag for access driver>
, so
this method checks whether the given name matches that pattern.name
- the parameter name to checkpublic static java.util.Collection<java.lang.String> getAllowedParameterNames(java.lang.String driver)
driver
- the driver to get the allowed parameter names forpublic static boolean isLocationParameter(java.lang.String paramName)
the
- parameter to testpublic static boolean hasAllowedParameterValues(java.lang.String paramName, Relation relation, DBObjectProvider pro)
paramName
- the parameter namerelation
- the parent relation (can be null to check generic model
values).pro
- the containing provider (can be null to check generic model
values).getAllowedParameterValues(java.lang.String, oracle.javatools.db.Relation, oracle.javatools.db.DBObjectProvider)
public static java.util.List<java.lang.String> getAllowedParameterValues(java.lang.String paramName, Relation relation, DBObjectProvider pro)
Should only call this if hasAllowedParameterValues(java.lang.String, oracle.javatools.db.Relation, oracle.javatools.db.DBObjectProvider)
returned
true.
paramName
- the parameter to testrelation
- the parent relation (can be null to check generic model
values).pro
- the containing provider (can be null to check generic model
values).null
otherwise.public static BigDataAccessParameterMetadata.TemplateValue getParameterTemplateValue(java.lang.String paramName)
For example, the com.oracle.bigdata.maxlen parameter this will return:
null
null
paramName
- a big data access parameter namenull
is there is no template.