public interface EntityKey
An actual (partial or full) key value of a key of an EntityClass
.
An EntityKey is an ordered set of N values corresponding to the ordered set
of K (K >= N) segments that describe a key of an EntityClass
.
If N == K then the EntityKey is full, otherwise (0 < N < K) it's partial.
The type of each segment is a Java primitive type (boolean, byte, char, short, int, long, float, double
)
or it is a String
.
An Entity Key may be used in subscriptions (SubscriptionParam.setEntityKey()
and Subscription.refreshEntity()
) or it
may be retrieved from entities (Entity.getFullEntityKey()
and Entity.getPartialEntityKey()
) and
then re-used.
Method Summary | |
---|---|
int |
getEntityClassID()
Returns the ID of the EntityClass related to this EntityKey. |
int |
getKeyID()
Returns the key ID of this key. |
int |
getNumSegments()
Returns N (N>0), the numbers of set segments of this EntityKey. |
Method Detail |
---|
int getKeyID()
The returned value is the same keyID
used as parameter of
Entity.getFullEntityKey()
or
Entity.getPartialEntityKey()
invocations that created this EntityKey.
int getEntityClassID()
EntityClass
related to this EntityKey.
The returned value is the EntityClassID of the Entity that created (via
Entity.getFullEntityKey()
or
Entity.getPartialEntityKey()
this
EntityKey.
EntityClass
related to this EntityKey.int getNumSegments()
The returned value is the
number of segments of the
EntityClass for a full EntityKey, or it is the same
numSegments
used as parameter of
Entity.getPartialEntityKey()
for a
partial EntityKey.