Corpus.java
01 /*
02  *  Corpus.java
03  *
04  *  Copyright (c) 1995-2012, The University of Sheffield. See the file
05  *  COPYRIGHT.txt in the software or at http://gate.ac.uk/gate/COPYRIGHT.txt
06  *
07  *  This file is part of GATE (see http://gate.ac.uk/), and is free
08  *  software, licenced under the GNU Library General Public License,
09  *  Version 2, June 1991 (in the distribution as file licence.html,
10  *  and also available at http://gate.ac.uk/gate/licence.html).
11  *
12  *  Hamish Cunningham, 19/Jan/2000
13  *
14  *  $Id: Corpus.java 17467 2014-02-27 12:54:45Z markagreenwood $
15  */
16 
17 package gate;
18 
19 import gate.event.CorpusListener;
20 
21 /** Corpora are lists of Document. TIPSTER equivalent: Collection.
22   */
23 public interface Corpus extends SimpleCorpus {
24 
25   /**
26    * Unloads the document from memory. Only needed if memory
27    * preservation is an issue. Only supported for Corpus which is
28    * stored in a Datastore. To get this document back in memory,
29    * use get() on Corpus or if you have its persistent ID, request it
30    * from the Factory.
31    <P>
32    * Transient Corpus objects do nothing,
33    * because there would be no way to get the document back
34    * again afterwards.
35    @param doc Document to be unloaded from memory.
36    */
37   public void unloadDocument(Document doc);
38 
39   /**
40    * This method returns true when the document is already loaded in memory.
41    * The transient corpora will always return true as they can only contain
42    * documents that are present in the memory.
43    */
44   public boolean isDocumentLoaded(int index);
45 
46 
47   /**
48    * Removes one of the listeners registered with this corpus.
49    @param l the listener to be removed.
50    */
51   public void removeCorpusListener(CorpusListener l);
52 
53   /**
54    * Registers a new {@link CorpusListener} with this corpus.
55    @param l the listener to be added.
56    */
57   public void addCorpusListener(CorpusListener l);
58 
59 // interface Corpus