Class AnnotationSetImpl

src/main/java/gate/annotation/AnnotationSetImpl.java:92–1439

Implementation of AnnotationSet. Has a number of indices, all bar one of which are null by default and are only constructed when asked for. Has lots of get methods with various selection criteria; these return views into the set, which are nonetheless valid sets in their own right (but will not nece

 * 
 */
public class AnnotationSetImpl extends AbstractSet<Annotation> implements
                                                              AnnotationSet {
  /** Freeze the serialization UID. */
  static final long serialVersionUID = 1479426765310434166L;
  /** The name of this set */
  String name = null;
  /** The document this set belongs to */
  DocumentImpl doc;
  /** Maps annotation ids (Integers) to Annotations */
  transient protected HashMap<Integer, Annotation> annotsById;
  /** Maps offsets (Longs) to nodes */
  transient RBTreeMap<Long,Node> nodesByOffset = null;
  /**
   * This field is used temporarily during serialisation to store all the
   * annotations that need to be saved. At all other times, this will be null;
   */
  private Annotation[] annotations;
  /** Maps annotation types (Strings) to AnnotationSets */
  transient Map<String, AnnotationSet> annotsByType = null;
  /**
   * Maps node ids (Integers) to Annotations or a Collection of Annotations that
   * start from that node
   */
  transient Map<Integer, Object> annotsByStartNode;
  protected transient Vector<AnnotationSetListener> annotationSetListeners;
  private transient Vector<GateListener> gateListeners;

  /**
   * A caching value that greatly improves the performance of get
   * methods that have a defined beginning and end. By tracking the
   * maximum length that an annotation can be, we know the maximum
   * amount of nodes outside of a specified range that must be checked
   * to see if an annotation starting at one of those nodes crosses into
   * the range. This mechanism is not perfect because we do not check if
   * we have to decrease it if an annotation is removed from the set.
   * However, usually annotations are removed because they are about to
   * be replaced with another one that is &gt;= to the length of the one
   * being replaced, so this isn't a big deal. At worst, it means that
   * the get methods simply checks a few more start positions than it
   * needs to.
   */
  protected transient Long longestAnnot = 0l;
  
  protected RelationSet relations = null;

  // Empty AnnotationSet to be returned instead of null
   //public final static AnnotationSet emptyAS;

   //static {
   //emptyAnnotationSet = new ImmutableAnnotationSetImpl(null,null);
   //}

  /** Construction from Document. */
  public AnnotationSetImpl(Document doc) {
    annotsById = new HashMap<Integer, Annotation>();
    this.doc = (DocumentImpl)doc;
  } // construction from document