AMETAS.data
Class AMETASPlaceUserIDMask

java.lang.Object
  extended byAMETAS.data.AMETASPlaceUserIDMask
All Implemented Interfaces:
java.io.Serializable

public class AMETASPlaceUserIDMask
extends java.lang.Object
implements java.io.Serializable

Stellt eine Teilmenge von AMETASPlaceUserIDs dar. Diese Klasse hat die gleichen Datenfelder wie AMETASPlaceUserID und dient dazu, eine Menge von Stellennutzern zu filtern. Sie ist verwandt mit AMETASPlaceUserID, ist aber unabhängig von ihr, was den Vererbungsbaum angeht. Sie wird z.B. verwendet, um die Empfänger einer AMETASMessage festzulegen. Dabei wird z.B. der Name (m_sName) in der Maske auf den gewünschten Wert und alle anderen Felder auf 0 bzw auf "null" gesetzt. Nun kann über die Methode contains(puid) festgestellt werden, ob der Stellennutzer, der die AMETASPlaceUserID puid besitzt, in die Maske paßt.

See Also:
AMETASPlaceUserID, AMETASMessage, AMETASMessageMask, Serialized Form

Field Summary
static long ANYTIME
          Spezieller Wert für den Zeitstempel.
 AMETASIdentityID m_iidStarter
          Die Identität der Instanz, welche den Stellennutzer gestartet hat.
 java.net.InetAddress m_IPAddress
          Herkunfts-IP-Adresse der Stellennutzer.
 long m_nTimeStamp
          Zeitstempel.
 java.lang.String m_sGroup
          Gruppe der Stellennutzer.
 java.lang.String m_sName
          Name der Stellennutzer.
 
Constructor Summary
AMETASPlaceUserIDMask()
          Generiert eine Broadcast-ID-Maske.
AMETASPlaceUserIDMask(AMETASPlaceUserID id)
          Erzeugt eine IDMaske aus einer PlaceUserID.
AMETASPlaceUserIDMask(java.net.InetAddress ipad, java.lang.String sName, java.lang.String sGroup, long nTimeStamp)
          Generiert eine ID-Maske.
AMETASPlaceUserIDMask(java.net.InetAddress ipad, java.lang.String sName, java.lang.String sGroup, long nTimeStamp, AMETASIdentityID iidStarter)
          Generiert eine ID-Maske.
 
Method Summary
 boolean contains(AMETASPlaceUserID id)
          Liefert true, wenn die übergebene Stellennutzer-ID in der hier definierten ID-Maske enthalten ist.
 boolean contains(AMETASPlaceUserIDMask idm)
          Liefert true, wenn die Stellennutzer-Menge, die durch idm charakterisiert wird, eine Teilmenge der Stellennutzer-Menge ist, die durch diese ID-Maske charakterisiert ist.
 boolean equals(java.lang.Object obj)
          Vergleicht zwei ID-Masken.
 AMETASPlaceUserID getUnicastID()
          Liefert eine PlaceUserID, wenn die Maske eine Unicast-Maske ist.
 int hashCode()
          Berechnet den Hashcode dieser ID-Maske.
 java.lang.String toString()
          Liefert eine Stringrepräsentation dieser ID-Maske.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

m_IPAddress

public java.net.InetAddress m_IPAddress
Herkunfts-IP-Adresse der Stellennutzer.


m_sGroup

public java.lang.String m_sGroup
Gruppe der Stellennutzer.


m_sName

public java.lang.String m_sName
Name der Stellennutzer. Per Konvention ist das der PU-Name.


m_nTimeStamp

public long m_nTimeStamp
Zeitstempel.


ANYTIME

public static final long ANYTIME
Spezieller Wert für den Zeitstempel. Kein Zeitstempel gegeben.

See Also:
Constant Field Values

m_iidStarter

public AMETASIdentityID m_iidStarter
Die Identität der Instanz, welche den Stellennutzer gestartet hat. Dieses Feld wird von der Stelle gesetzt, auf der der Stellennutzer gestartet wird und entzieht sich dem Zugriff durch den Stellennutzer. Es kann genau einmal gesetzt werden.

Since:
2.4.0
Constructor Detail

AMETASPlaceUserIDMask

public AMETASPlaceUserIDMask(AMETASPlaceUserID id)
Erzeugt eine IDMaske aus einer PlaceUserID. Mit dieser Maske wird also nur der Stellennutzer addressiert, dem diese ID gehört.

Parameters:
id - ID eines einzelnen Stellennutzers.

AMETASPlaceUserIDMask

public AMETASPlaceUserIDMask(java.net.InetAddress ipad,
                             java.lang.String sName,
                             java.lang.String sGroup,
                             long nTimeStamp)
Generiert eine ID-Maske. Diese Methode wurde aus Kompatibilitätsgründen beibehalten. Sie nimmt keine Starter-ID entgegen und setzt dieses Feld der Maske auf null.

Parameters:
ipad - IP-Adresse oder null.
sGroup - Gruppe oder null.
sName - Name oder null.
nTimeStamp - Zeitstempel oder 0.

AMETASPlaceUserIDMask

public AMETASPlaceUserIDMask(java.net.InetAddress ipad,
                             java.lang.String sName,
                             java.lang.String sGroup,
                             long nTimeStamp,
                             AMETASIdentityID iidStarter)
Generiert eine ID-Maske.

Parameters:
ipad - IP-Adresse oder null.
sGroup - Gruppe oder null.
sName - Name oder null.
nTimeStamp - Zeitstempel oder ANYTIME.
iidStarter - IdentityID des Starters oder null
Since:
2.4.0

AMETASPlaceUserIDMask

public AMETASPlaceUserIDMask()
Generiert eine Broadcast-ID-Maske. IP-Adresse, Name, Gruppe und Starter-ID sind null, der Zeitstempel ist ANYTIME.

Method Detail

getUnicastID

public AMETASPlaceUserID getUnicastID()
Liefert eine PlaceUserID, wenn die Maske eine Unicast-Maske ist.

Returns:
PlaceUserID oder null, wenn es eine Multi-/Broadcastmaske ist.
Since:
2.6.0

equals

public boolean equals(java.lang.Object obj)
Vergleicht zwei ID-Masken.

Parameters:
obj - Zu vergleichende ID-Maske.
Returns:
true, wenn die beiden Masken gleich sind, sonst false.

contains

public boolean contains(AMETASPlaceUserIDMask idm)
Liefert true, wenn die Stellennutzer-Menge, die durch idm charakterisiert wird, eine Teilmenge der Stellennutzer-Menge ist, die durch diese ID-Maske charakterisiert ist.

Parameters:
idm - Zu vergleichende ID-Maske.
Returns:
true, wenn alle Felder, die in dieser Maske mit einem Wert ungleich null belegt sind, in idm mit dem gleichen Wert belegt sind, sonst false.

contains

public boolean contains(AMETASPlaceUserID id)
Liefert true, wenn die übergebene Stellennutzer-ID in der hier definierten ID-Maske enthalten ist.

Parameters:
id - ID eines einzelnen Stellennutzers.
Returns:
true, wenn alle Felder, die in dieser Maske mit einem Wert ungleich null belegt sind, in id mit dem gleichen Wert belegt sind, sonst false.

hashCode

public int hashCode()
Berechnet den Hashcode dieser ID-Maske.

Returns:
Hashcode der Maske.

toString

public java.lang.String toString()
Liefert eine Stringrepräsentation dieser ID-Maske.

Returns:
Stringrepräsentation.