public interface EntityClass
Interface that describes a specific market/service class.
All market/service EntityClasses share a set of common methods to:
class name
,
class ID
,
number of segments of a given KeyID
.
In addition all market/service objects, that implement the Entity
sub-interface, share, as well, these methods.
If necessary explicitly objects that implement this interface are created and
returned by the JFT.getEntityClass()
method.
Field Summary | |
---|---|
static int |
TYPE_ENTITY
|
static int |
TYPE_ENUM
|
Method Summary | |
---|---|
int |
getEntityClassID()
Returns the ID that identifies the EntityClass. |
String |
getEntityClassName()
Returns the name that identifies the EntityClass. |
EntityField[] |
getEntityFields()
|
int |
getNumSegments(int keyID)
Returns the number of segments of the given KeyID of this EntityClass. |
int |
getType()
|
boolean |
isKey(int keyID)
Check if a given keyID is an index of a key for this
EntityClass. |
boolean |
isKey(int keyID,
boolean checkPrimary)
Check if a given keyID is an index of a primary or
duplicate key for this EntityClass. |
Entity |
makeEntity()
|
Field Detail |
---|
static final int TYPE_ENTITY
static final int TYPE_ENUM
Method Detail |
---|
String getEntityClassName()
null
and empty strings are never returned.int getEntityClassID()
boolean isKey(int keyID)
keyID
is an index of a key for this
EntityClass.
keyID
- index to be checked
true
if keyID
is an index of a key
for this EntityClass, false
otherwise.boolean isKey(int keyID, boolean checkPrimary)
keyID
is an index of a primary or
duplicate key for this EntityClass.
keyID
- index to be checkedcheckPrimary
- check for primary or duplicate key index
true
if keyID
is an index of a key
for this EntityClass and it refers a primary or duplicate key as
specified by checkPrimary
parameter, false
otherwise.int getNumSegments(int keyID)
keyID
- the index of a key of this class.
KeyID
parameter is not
a valid index of a key of this class.int getType()
EntityField[] getEntityFields()
Entity makeEntity()