com.orchestranetworks.addon.dex.mapping

Class EBXField

java.lang.Object

com.orchestranetworks.addon.dex.mapping.EBXField

All Implemented Interfaces:

Field

Direct Known Subclasses:

EBXLinkField

public class EBXField
extends Object
implements Field

Specifies the configuration used for an EBX® field.

Since:

2.3.0

Constructor Summary

Constructors

Constructor and Description
EBXField(com.orchestranetworks.schema.SchemaNode schemaNode)
EBXField(com.orchestranetworks.schema.SchemaNode schemaNode, FieldAttribute fieldAttribute) Used to create an EBX® field with the specified schema node and FieldAttribute enumeration.
EBXField(com.orchestranetworks.schema.SchemaNode schemaNode, FieldAttribute fieldAttribute, Locale locale) Used to create an EBX® field with the specified schema node, locale and FieldAttribute enumeration.
EBXField(com.orchestranetworks.schema.SchemaNode schemaNode, Locale locale)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
FieldAttribute	getFieldAttribute() Returns the specified FieldAttribute for this EBX® field.
int	getIndex() Returns the specified field index.
String	getLabel() Returns the specified field label.
String	getName() Returns the specified field name.
com.orchestranetworks.schema.SchemaNode	getSchemaNode() Returns the specified schema node.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

EBXField

public EBXField(com.orchestranetworks.schema.SchemaNode schemaNode)
         throws DataExchangeException

Throws:

DataExchangeException

EBXField

public EBXField(com.orchestranetworks.schema.SchemaNode schemaNode,
                Locale locale)
         throws DataExchangeException

Throws:

DataExchangeException

EBXField

public EBXField(com.orchestranetworks.schema.SchemaNode schemaNode,
                FieldAttribute fieldAttribute)
         throws DataExchangeException

Used to create an EBX® field with the specified schema node and FieldAttribute enumeration. If the FieldAttribute enumeration is not a NO_SOURCE_FIELD, the schema node must not be null. Otherwise, an exception will be thrown.

Throws:

DataExchangeException

Since:

2.4.0

EBXField

public EBXField(com.orchestranetworks.schema.SchemaNode schemaNode,
                FieldAttribute fieldAttribute,
                Locale locale)
         throws DataExchangeException

Used to create an EBX® field with the specified schema node, locale and FieldAttribute enumeration. If the FieldAttribute enumeration is not a NO_SOURCE_FIELD, the schema node must not be null. Otherwise, an exception will be thrown.

Throws:

DataExchangeException

Since:

2.4.0

Method Detail

getName

public final String getName()

Returns the specified field name.

Specified by:

getName in interface Field

getLabel

public final String getLabel()

Returns the specified field label.

Specified by:

getLabel in interface Field

getSchemaNode

public final com.orchestranetworks.schema.SchemaNode getSchemaNode()

Returns the specified schema node.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getIndex

public final int getIndex()

Returns the specified field index.

Specified by:

getIndex in interface Field

getFieldAttribute

public final FieldAttribute getFieldAttribute()

Returns the specified FieldAttribute for this EBX® field.

Since:

2.4.0