Package com.orchestranetworks.addon.dex.mapping

Class SpreadsheetField

java.lang.Object

com.orchestranetworks.addon.dex.mapping.SpreadsheetField

All Implemented Interfaces:

Field

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

Specifies the configuration used for a spreadsheet field.

Since:

2.3.0

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
FieldAttribute	getFieldAttribute()	Returns the specified FieldAttribute for this spreadsheet 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()

Methods inherited from class java.lang.Object

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

Constructor Detail

SpreadsheetField

public SpreadsheetField(int index)
                 throws DataExchangeException

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

Throws:

DataExchangeException

SpreadsheetField

public SpreadsheetField(int index,
                        FieldAttribute fieldAttribute)
                 throws DataExchangeException

Used to create a spreadsheet field with the 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

SpreadsheetField

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

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

Throws:

DataExchangeException

SpreadsheetField

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

Used to create a spreadsheet field with the specified index, name, label 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

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

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 spreadsheet field.

Since:

2.4.0