notio
Class Marker

java.lang.Object
  |
  +--notio.Marker

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

The marker class.

See Also:
Serialized Form

Constructor Summary
Marker(MarkerSet newMarkerSet)
          Construct a new marker belonging to the specified marker set.
Marker(MarkerSet newMarkerSet, java.lang.Object newIndividual)
          Construct a new marker belonging to the specified marker set and with the specified Object as its individual.
 
Method Summary
 void addTypeConformance(ConceptType newType)
          Adds a new concept type to the set of those to which this marker conforms.
 boolean conformsToType(ConceptType queryType)
          Test whether the marker conforms to the specified concept type.
 void freeIndividual()
          Frees the individual associated with this marker.
 java.lang.Object getIndividual()
          Returns the individual corresponding to this marker.
 java.lang.String getMarkerID()
          Returns the marker ID for this marker.
 MarkerSet getMarkerSet()
          Returns the marker set to which this marker belongs.
 void removeTypeConformance(ConceptType deadType)
          Removes a concept type from the set of those to which this marker conforms.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Marker

public Marker(MarkerSet newMarkerSet,
              java.lang.Object newIndividual)
Construct a new marker belonging to the specified marker set and with the specified Object as its individual.
Parameters:
newMarkerSet - the marker set to which this marker will belong.
newIndividual - the Object that is the individual corresponding to this marker.

Marker

public Marker(MarkerSet newMarkerSet)
Construct a new marker belonging to the specified marker set.
Parameters:
newMarkerSet - the marker set to which this marker will belong.
Method Detail

getMarkerID

public java.lang.String getMarkerID()
Returns the marker ID for this marker. This is a string that unique represents the marker within its current marker set. Note, the ID is automatically assigned when the marker is added to its marker set.
Returns:
the ID for this marker.

freeIndividual

public void freeIndividual()
Frees the individual associated with this marker. This means that the reference to the individual will be set to null, allowing it to be garbage-collected if no other references exist. The marker remains as an entry in its MarkerSet but is no longer associated with an individual. If no individual is associated with this Marker when freeIndividual() is called, nothing happens.

getIndividual

public java.lang.Object getIndividual()
Returns the individual corresponding to this marker.
Returns:
the Object that is the individual corresponding to this marker.

getMarkerSet

public MarkerSet getMarkerSet()
Returns the marker set to which this marker belongs.
Returns:
the MarkerSet for this marker.

conformsToType

public boolean conformsToType(ConceptType queryType)
Test whether the marker conforms to the specified concept type.
Parameters:
queryType - the concept type we are testing for conformance.
Returns:
true if this marker conforms to the specified concept type.

addTypeConformance

public void addTypeConformance(ConceptType newType)
Adds a new concept type to the set of those to which this marker conforms.
Parameters:
newType - the concept type being added.

removeTypeConformance

public void removeTypeConformance(ConceptType deadType)
Removes a concept type from the set of those to which this marker conforms.
Parameters:
deadType - the concept type being removed.


Copyright 1998-1999 Finnegan Southey