Class DocumentImpl

src/main/java/gate/corpora/DocumentImpl.java:173–2565

Represents the commonalities between all sorts of documents. Editing The DocumentImpl class implements the Document interface. The DocumentContentImpl class models the textual or audio-visual materials which are the source and content of Documents. The AnnotationSetImpl class supplies

 * </PRE>
 */
@CreoleResource(name = "GATE Document", interfaceName = "gate.Document",
    comment = "GATE transient document.", icon = "document",
    helpURL = "http://gate.ac.uk/userguide/sec:developer:documents")
public class DocumentImpl extends AbstractLanguageResource implements
                                                          TextualDocument,
                                                          CreoleListener,
                                                          DatastoreListener {
  /** Debug flag */
  private static final boolean DEBUG = false;

  /**
   * If you set this flag to true the original content of the document will be
   * kept in the document feature. <br>
   * Default value is false to avoid the unnecessary waste of memory
   */
  private Boolean preserveOriginalContent = Boolean.FALSE;

  /**
   * If you set this flag to true the repositioning information for the document
   * will be kept in the document feature. <br>
   * Default value is false to avoid the unnecessary waste of time and memory
   */
  private Boolean collectRepositioningInfo = Boolean.FALSE;

  /**
   * This is a variable which contains the latest crossed over annotation found
   * during export with preserving format, i.e., toXml(annotations) method.
   */
  private Annotation crossedOverAnnotation = null;

  
  /** Flag to determine whether to serialize namespace information held as
   *  annotation features into namespace prefix and URI in the XML
   */
  private boolean serializeNamespaceInfo = false;
  /** Feature name used for namespace uri in namespaced elements */
  private String namespaceURIFeature = null;
  /** Feature name used for namespace prefix in namespaced elements */
  private String namespacePrefixFeature = null;

  
  /** Default construction. Content left empty. */
  public DocumentImpl() {
    content = new DocumentContentImpl();
    stringContent = "";

    /** We will attempt to serialize namespace if
     *  three parameters are set in the global or local config file:
     *  ADD_NAMESPACE_FEATURES: boolean flag
     *  ELEMENT_NAMESPACE_URI: feature name used to hold namespace URI
     *  ELEMENT_NAMESPACE_PREFIX: feature name used to hold namespace prefix
     */
    OptionsMap configData = Gate.getUserConfig();

    boolean addNSFeature = Boolean.parseBoolean((String)configData.get(GateConstants.ADD_NAMESPACE_FEATURES));
    namespaceURIFeature = (String) configData.get(GateConstants.ELEMENT_NAMESPACE_URI);
    namespacePrefixFeature = (String) configData.get(GateConstants.ELEMENT_NAMESPACE_PREFIX);