Package com.orchestranetworks.addon.dex.mapping

Class SQLField

java.lang.Object

com.orchestranetworks.addon.dex.mapping.SQLField

All Implemented Interfaces:

Field

public final class SQLField
extends java.lang.Object
implements Field

Specifies the configuration used for an SQL field in an external database.

Since:

2.3.0

Constructor Summary

Constructors

Constructor	Description
SQLField(java.lang.String name)	Used to create a SQL field with specified name.
SQLField(java.lang.String name, FieldAttribute fieldAttribute)	Used to create a SQL field with the specified name and FieldAttribute enumeration.
SQLField(java.lang.String name, java.lang.String label, SQLDataType sqlDataType)	Used to create a SQL field with the specified name, label, data type.
SQLField(java.lang.String name, java.lang.String label, SQLDataType sqlDataType, FieldAttribute fieldAttribute)	Used to create a SQL field with the specified name, label, data type and FieldAttribute enumeration.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
SQLDataType	getDataType()	Returns an instance of SQLDataType used to identify generic SQL data types.
FieldAttribute	getFieldAttribute()	Returns the specified FieldAttribute for this SQL field.
int	getIndex()	Returns the specified field order.
java.lang.String	getLabel()	Returns the specified field label.
java.lang.String	getName()	Returns the specified field name.
int	hashCode()
void	setDataType(SQLDataType sqlDataType)	Sets the field data type value, or SQLDataType object value.
void	setLabel(java.lang.String label)	Sets a label to this field.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SQLField

public SQLField(java.lang.String name)
         throws DataExchangeException

Used to create a SQL field with specified name. If field name is null or empty, an exception will be thrown.

Throws:

DataExchangeException

SQLField

public SQLField(java.lang.String name,
                FieldAttribute fieldAttribute)
         throws DataExchangeException

Used to create a SQL field with the specified name and FieldAttribute enumeration. If the FieldAttribute enumeration is not a NO_SOURCE_FIELD, the field name must not null or empty. Otherwise, an exception will be thrown.

Throws:

DataExchangeException

Since:

2.4.0

SQLField

public SQLField(java.lang.String name,
                java.lang.String label,
                SQLDataType sqlDataType)
         throws DataExchangeException

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(java.lang.String name,
                java.lang.String label,
                SQLDataType sqlDataType,
                FieldAttribute fieldAttribute)
         throws DataExchangeException

Used to create a SQL field with the specified name, label, data type and FieldAttribute enumeration. If the FieldAttribute enumeration is not a NO_SOURCE_FIELD, the field name must not null or empty. Otherwise, an exception will be thrown.

Throws:

DataExchangeException

Since:

2.4.0

Method Detail

getName

public java.lang.String getName()

Returns the specified field name.

Specified by:

getName in interface Field

setLabel

public void setLabel(java.lang.String label)

Sets a label to this field.

getLabel

public java.lang.String getLabel()

Returns the specified field label.

Specified by:

getLabel in interface Field

setDataType

public void setDataType(SQLDataType sqlDataType)

Sets the field data type value, or SQLDataType object value.

getDataType

public SQLDataType getDataType()

Returns an instance of SQLDataType used to identify generic SQL data types.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getIndex

public int getIndex()

Description copied from interface: Field

Returns the specified field order.

Specified by:

getIndex in interface Field

getFieldAttribute

public final FieldAttribute getFieldAttribute()

Returns the specified FieldAttribute for this SQL field.

Since:

2.4.0