Package com.orchestranetworks.addon.dex.mapping

Class CSVField

java.lang.Object

com.orchestranetworks.addon.dex.mapping.CSVField

All Implemented Interfaces:

Field

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

Specifies CSV field configuration information.

Since:

2.3.0

Constructor Summary

Constructors

Constructor	Description
CSVField(int index)	Used to create a CSV field with specified index.
CSVField(int index, FieldAttribute fieldAttribute)	Used to create a CSV field with specified index and FieldAttribute enumeration.
CSVField(int index, java.lang.String name, java.lang.String label)	Used to create a CSV field with specified index, name and label.
CSVField(int index, java.lang.String name, java.lang.String label, FieldAttribute fieldAttribute)	Used to create a CSV field with specified index, name, label and FieldAttribute enumeration.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
java.lang.String	getDateFormatPattern()	Returns the specified date, time or date time format if the field is date, time or date time type.
FieldAttribute	getFieldAttribute()	Returns the specified FieldAttribute for this CSV field.
int	getIndex()	Returns the specified field index.
java.lang.String	getLabel()	Returns the specified field label.
java.lang.String	getName()	Returns the specified field name.
int	hashCode()
void	setDateFormatPattern(java.lang.String dateFormatPattern)	Sets a date, time or date time format string to this value if the field is date, time or date time type.

Methods inherited from class java.lang.Object

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

Constructor Detail

CSVField

public CSVField(int index)
         throws DataExchangeException

Used to create a CSV field with specified index. Index starts with zero. If index less than zero, an exception will be thrown.

Throws:

DataExchangeException

CSVField

public CSVField(int index,
                FieldAttribute fieldAttribute)
         throws DataExchangeException

Used to create a CSV field with specified index and FieldAttribute enumeration. If the FieldAttribute enumeration is not a NO_SOURCE_FIELD, the index must be equal to or greater than zero. Otherwise, an exception will be thrown.

Throws:

DataExchangeException

Since:

2.4.0

CSVField

public CSVField(int index,
                java.lang.String name,
                java.lang.String label)
         throws DataExchangeException

Used to create a CSV field with specified index, name and label.

Throws:

DataExchangeException

CSVField

public CSVField(int index,
                java.lang.String name,
                java.lang.String label,
                FieldAttribute fieldAttribute)
         throws DataExchangeException

Used to create a CSV field with specified index, name, label and FieldAttribute enumeration. If the FieldAttribute enumeration is not a NO_SOURCE_FIELD, the index must be equal or greater than zero. 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

getLabel

public java.lang.String getLabel()

Returns the specified field label.

Specified by:

getLabel in interface Field

getIndex

public int getIndex()

Returns the specified field index.

Specified by:

getIndex in interface Field

getDateFormatPattern

public java.lang.String getDateFormatPattern()

Returns the specified date, time or date time format if the field is date, time or date time type.

setDateFormatPattern

public void setDateFormatPattern(java.lang.String dateFormatPattern)

Sets a date, time or date time format string to this value if the field is date, time or date time type.

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

getFieldAttribute

public final FieldAttribute getFieldAttribute()

Returns the specified FieldAttribute for this CSV field.

Since:

2.4.0