public final class CustomWrapperSchemaParameter extends Object
CustomWrapperSchemaParameter[]
).
Types
, including
java.sql.Types.ARRAY
and java.sql.Types.STRUCT
, in case they
are compound.
Modifier and Type | Field and Description |
---|---|
static int |
ASC_AND_DESC_SORT
This parameter supports both ascending and descending sort.
|
static int |
ASCENDING_SORT
This parameter supports ascending sort.
|
static int |
DESCENDING_SORT
This parameter supports descending sort.
|
static int |
NOT_SORTABLE
This parameter cannot be sorted.
|
Constructor and Description |
---|
CustomWrapperSchemaParameter(String name,
int type)
Creates a simple schema parameter with the following default properties:
not mandatory
searchable
nullable
updateable
sortable (supports ascending and descending sort)
getColumns() returns null
|
CustomWrapperSchemaParameter(String name,
int type,
CustomWrapperSchemaParameter[] columns)
Creates a complex schema parameter with the following default properties:
not mandatory
not searchable
not updateable
not sortable
nullable
|
CustomWrapperSchemaParameter(String name,
int type,
CustomWrapperSchemaParameter[] columns,
boolean isSearchable,
int sortableStatus,
boolean isUpdateable,
boolean isNullable,
boolean isMandatory)
Creates a schema parameter without any default property.
|
CustomWrapperSchemaParameter(String name,
int type,
Integer typeSize,
String typeName,
Integer typeRadix,
Integer typeDecimals,
Map<String,String> extraProperties)
Creates a simple schema parameter with the following default properties:
not mandatory
searchable
nullable
updateable
sortable (supports ascending and descending sort)
getColumns() returns null
|
CustomWrapperSchemaParameter(String name,
int type,
Integer typeSize,
String typeName,
Integer typeRadix,
Integer typeDecimals,
Map<String,String> extraProperties,
CustomWrapperSchemaParameter[] columns)
Creates a complex schema parameter with the following default properties:
not mandatory
not searchable
not updateable
not sortable
nullable
properties
|
CustomWrapperSchemaParameter(String name,
int type,
Integer typeSize,
String typeName,
Integer typeRadix,
Integer typeDecimals,
Map<String,String> extraProperties,
CustomWrapperSchemaParameter[] columns,
boolean isSearchable,
int sortableStatus,
boolean isUpdateable,
boolean isNullable,
boolean isMandatory)
Creates a schema parameter without any default property.
|
Modifier and Type | Method and Description |
---|---|
CustomWrapperSchemaParameter[] |
getColumns() |
Map<String,String> |
getExtraProperties() |
String |
getName() |
Class<?> |
getParameterClass()
Obtains the Java class of this schema parameter according to its type.
|
int |
getSortableStatus() |
int |
getType() |
Integer |
getTypeDecimals() |
String |
getTypeName() |
Integer |
getTypeRadix() |
Integer |
getTypeSize() |
boolean |
isMandatory() |
boolean |
isNullable() |
boolean |
isSearchable() |
boolean |
isUpdateable() |
void |
setExtraProperties(Map<String,String> extraProperties) |
String |
toString() |
public static final int NOT_SORTABLE
public static final int ASCENDING_SORT
public static final int DESCENDING_SORT
public static final int ASC_AND_DESC_SORT
public CustomWrapperSchemaParameter(String name, int type, CustomWrapperSchemaParameter[] columns, boolean isSearchable, int sortableStatus, boolean isUpdateable, boolean isNullable, boolean isMandatory)
name
- the name of this schema parametertype
- one of the types defined in java.sql.Types
.columns
- an array of schema parameters, if this parameter is to be compound,
or null
otherwise.isSearchable
- true
if this parameter can be searched or
false
otherwise.sortableStatus
- one of NOT_SORTABLE
, ASCENDING_SORT
,
DESCENDING_SORT
or ASC_AND_DESC_SORT
.isUpdateable
- true
if this parameter can be updated or
false
otherwise.isNullable
- true
if this parameter can be made null or
false
otherwise.isMandatory
- true
if this parameter is mandatory or
false
otherwise. This parameter will be ignored
if columns
is not null
.public CustomWrapperSchemaParameter(String name, int type, Integer typeSize, String typeName, Integer typeRadix, Integer typeDecimals, Map<String,String> extraProperties, CustomWrapperSchemaParameter[] columns, boolean isSearchable, int sortableStatus, boolean isUpdateable, boolean isNullable, boolean isMandatory)
name
- the name of this schema parametertype
- one of the types defined in the class Types
of the JDBC API.typeSize
- its meaning depends on the type of the field:
text
, it indicates the maximum length of the
field.int
and
long
fields, this number is 0
.typeName
- name of the type of the field in the source type properties of the field.
E.g. VARCHAR
, NCHAR
, INTEGER
, BIGINT
,
etc.
These are the names of the constants defined in the class Types
of the
JDBC API.typeRadix
- number of fractional digits that a value of this field could store.typeDecimals
- for fields of type decimal
, is the value of Type decimals
of the source type properties of the field. Set this to 0
, for fields
that are not decimal
.columns
- an array of schema parameters, if this parameter is to be compound, or
null
otherwise.isSearchable
- true
if this parameter can be searched or false
otherwise.sortableStatus
- one of NOT_SORTABLE
, ASCENDING_SORT
,
DESCENDING_SORT
or ASC_AND_DESC_SORT
.isUpdateable
- true
if this parameter can be updated or false
otherwise.isNullable
- true
if this parameter can be made null or false
otherwise.isMandatory
- true
if this parameter is mandatory or false
otherwise. This parameter will be ignored if columns
is not
null
.public CustomWrapperSchemaParameter(String name, int type, CustomWrapperSchemaParameter[] columns)
name
- this schema parameter's name.type
- this schema parameter's type (one of java.sql.Types
).columns
- an array of schema parameters, representing this parameter's sub-parameters.public CustomWrapperSchemaParameter(String name, int type, Integer typeSize, String typeName, Integer typeRadix, Integer typeDecimals, Map<String,String> extraProperties, CustomWrapperSchemaParameter[] columns)
name
- this schema parameter's name.type
- this schema parameter's type (one of java.sql.Types
).typeSize
- its meaning depends on the type of the field:
text
, it indicates the maximum length of the
field.int
and
long
fields, this number is 0
.typeName
- name of the type of the field in the source type properties of the field.
E.g. VARCHAR
, NCHAR
, INTEGER
, BIGINT
,
etc.
These are the names of the constants defined in the class Types
of the
JDBC API.typeRadix
- number of fractional digits that a value of this field could store.typeDecimals
- for fields of type decimal
, is the value of Type decimals
of the source type properties of the field. Set this to 0
, for fields
that are not decimal
.columns
- an array of schema parameters, representing this parameter's sub-parameters.public CustomWrapperSchemaParameter(String name, int type)
getColumns()
returns null
name
- this schema parameter's name.type
- this schema parameter's type (one of java.sql.Types
).public CustomWrapperSchemaParameter(String name, int type, Integer typeSize, String typeName, Integer typeRadix, Integer typeDecimals, Map<String,String> extraProperties)
getColumns()
returns null
name
- this schema parameter's name.type
- this schema parameter's type (one of constants defined in the class Types
).typeSize
- its meaning depends on the type of the field:
text
, it indicates the maximum length of the
field.int
and
long
fields, this number is 0
.typeName
- name of the type of the field in the source type properties of the field.
E.g. VARCHAR
, NCHAR
, INTEGER
, BIGINT
,
etc.
These are the names of the constants defined in the class Types
of the
JDBC API.typeRadix
- number of fractional digits that a value of this field could store.typeDecimals
- for fields of type decimal
, is the value of Type decimals
of the source type properties of the field. Set this to 0
, for fields
that are not decimal
.public String getName()
public int getType()
public Integer getTypeRadix()
public Integer getTypeSize()
public String getTypeName()
public Integer getTypeDecimals()
public CustomWrapperSchemaParameter[] getColumns()
public boolean isSearchable()
true
if this parameter can be searched or false
otherwise.public int getSortableStatus()
NOT_SORTABLE
, ASCENDING_SORT
, DESCENDING_SORT
or ASC_AND_DESC_SORT
.public boolean isUpdateable()
true
if this parameter can be updated or false
otherwise.public boolean isNullable()
true
if this parameter can be made null or false
otherwise.public boolean isMandatory()
true
if this parameter is mandatory or false
otherwise.public Class<?> getParameterClass()
java.sql.Types.ARRAY
= Object[]
java.sql.Types.BIGINT
= Long
java.sql.Types.BINARY
= Byte[]
java.sql.Types.BIT
= Boolean
java.sql.Types.BLOB
= Byte[]
java.sql.Types.BOOLEAN
= Boolean
java.sql.Types.CHAR
= Character
java.sql.Types.CLOB
= Character[]
java.sql.Types.DATALINK
= java.net.URL
java.sql.Types.DATE
= java.sql.Date
java.sql.Types.DECIMAL
= java.math.BigDecimal
java.sql.Types.DISTINCT
= Object
java.sql.Types.DOUBLE
= Double
java.sql.Types.FLOAT
= Float
java.sql.Types.INTEGER
= Integer
java.sql.Types.JAVA_OBJECT
= Object
java.sql.Types.LONGVARBINARY
= Byte[]
java.sql.Types.LONGVARCHAR
= String
java.sql.Types.NUMERIC
= java.math.BigDecimal
java.sql.Types.REAL
= Double
java.sql.Types.SMALLINT
= Integer
java.sql.Types.STRUCT
= java.sql.Struct
java.sql.Types.TIME
= java.sql.Time
java.sql.Types.TIMESTAMP
= java.sql.Timestamp
java.sql.Types.TIMESTAMP_WITH_TIMEZONE
= java.time.OffsetDateTime
java.sql.Types.TIME_WITH_TIMEZONE
= java.time.OffsetTime
java.sql.Types.TIMESTAMP
= java.sql.Timestamp
java.sql.Types.TINYINT
= Integer
java.sql.Types.VARBINARY
= Byte[]
java.sql.Types.VARCHAR
= String
Copyright © 2024 Denodo Technologies. All rights reserved.