Class SQLField
java.lang.Object
com.orchestranetworks.addon.dex.mapping.SQLField
- All Implemented Interfaces:
Field
Specifies the configuration used for an SQL field in an external database.
- Since:
- 2.3.0
-
Constructor Summary
ConstructorsConstructorDescriptionUsed to create a SQL field with specified name.SQLField
(String name, FieldAttribute fieldAttribute) Used to create a SQL field with the specified name andFieldAttribute
enumeration.SQLField
(String name, String label, SQLDataType sqlDataType) Used to create a SQL field with the specified name, label, data type.SQLField
(String name, String label, SQLDataType sqlDataType, FieldAttribute fieldAttribute) Used to create a SQL field with the specified name, label, data type andFieldAttribute
enumeration. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns an instance ofSQLDataType
used to identify generic SQL data types.final FieldAttribute
Returns the specifiedFieldAttribute
for this SQL field.int
getIndex()
Returns the specified field order.getLabel()
Returns the specified field label.getName()
Returns the specified field name.int
hashCode()
void
setDataType
(SQLDataType sqlDataType) Sets the field data type value, orSQLDataType
object value.void
Sets a label to this field.
-
Constructor Details
-
SQLField
Used to create a SQL field with specified name. If field name is null or empty, an exception will be thrown.- Throws:
DataExchangeException
-
SQLField
Used to create a SQL field with the specified name andFieldAttribute
enumeration. If theFieldAttribute
enumeration is not aNO_SOURCE_FIELD
, the field name must not null or empty. Otherwise, an exception will be thrown.- Throws:
DataExchangeException
- Since:
- 2.4.0
-
SQLField
Used to create a SQL field with the specified name, label, data type. If the field name is null or empty, an exception will be thrown.- Throws:
DataExchangeException
-
SQLField
public SQLField(String name, String label, SQLDataType sqlDataType, FieldAttribute fieldAttribute) throws DataExchangeException Used to create a SQL field with the specified name, label, data type andFieldAttribute
enumeration. If theFieldAttribute
enumeration is not aNO_SOURCE_FIELD
, the field name must not null or empty. Otherwise, an exception will be thrown.- Throws:
DataExchangeException
- Since:
- 2.4.0
-
-
Method Details
-
getName
Returns the specified field name. -
setLabel
Sets a label to this field. -
getLabel
Returns the specified field label. -
setDataType
Sets the field data type value, orSQLDataType
object value. -
getDataType
Returns an instance ofSQLDataType
used to identify generic SQL data types. -
hashCode
public int hashCode() -
equals
-
getIndex
public int getIndex()Description copied from interface:Field
Returns the specified field order. -
getFieldAttribute
Returns the specifiedFieldAttribute
for this SQL field.- Since:
- 2.4.0
-