Merge branch 'xml-import-simple-mode'

Author: maltem-za

src/main/java/de/catma/document/source/contenthandler/AbstractSourceContentHandler.java

@@ -18,40 +18,28 @@
  */
 package de.catma.document.source.contenthandler;
 
-import java.io.IOException;
-
 import de.catma.document.source.SourceDocumentInfo;
 
+import java.io.IOException;
+
 /**
  * Basic implementation that provides lazy loading.
- * 
- * @author [email protected]
- *
  */
 public abstract class AbstractSourceContentHandler implements SourceContentHandler {
+	private SourceDocumentInfo sourceDocumentInfo;
+	private String content;
 
-    private SourceDocumentInfo sourceDocumentInfo;
-    private String content;
-    
-    /* (non-Javadoc)
-     * @see de.catma.document.source.contenthandler.SourceContentHandler#setSourceDocumentInfo(de.catma.document.source.SourceDocumentInfo)
-     */
-    public void setSourceDocumentInfo(SourceDocumentInfo sourceDocumentInfo) {
+	@Override
+	public void setSourceDocumentInfo(SourceDocumentInfo sourceDocumentInfo) {
 		this.sourceDocumentInfo = sourceDocumentInfo;
 	}
-    
-    /* (non-Javadoc)
-     * @see de.catma.document.source.contenthandler.SourceContentHandler#getSourceDocumentInfo()
-     */
-    public SourceDocumentInfo getSourceDocumentInfo() {
+
+	@Override
+	public SourceDocumentInfo getSourceDocumentInfo() {
 		return sourceDocumentInfo;
 	}
 
-	/**
-	 * Does lazy loading, first call will lead to a {@link #load()}.
-	 * 
-	 * @see de.catma.document.source.contenthandler.SourceContentHandler#getContent()
-	 */
+	@Override
 	public String getContent() throws IOException {
 		if (content == null) {
 			load();
@@ -60,29 +48,26 @@ public String getContent() throws IOException {
 	}
 
 	/**
-	 * @param content the content of the {@link de.catma.document.source.SourceDocument}. To be used
-	 * by concrete implementations.
+	 * To be used by concrete implementations to set the content.
+	 *
+	 * @param content the entire document text
 	 */
 	protected void setContent(String content) {
 		this.content = content;
 	}
-	
-	/* (non-Javadoc)
-	 * @see de.catma.document.source.contenthandler.SourceContentHandler#unload()
-	 */
+
+	@Override
 	public void unload() {
 		content = null;
 	}
 
-    /* (non-Javadoc)
-     * @see de.catma.document.source.contenthandler.SourceContentHandler#isLoaded()
-     */
-    public boolean isLoaded() {
-    	return (content != null);
-    }
-    
-    @Override
-    public boolean hasIntrinsicMarkupCollection() {
-    	return false;
-    }
+	@Override
+	public boolean isLoaded() {
+		return content != null;
+	}
+
+	@Override
+	public boolean hasIntrinsicAnnotationCollection() {
+		return false;
+	}
 }

src/main/java/de/catma/document/source/contenthandler/OldXMLContentHandler.java

@@ -18,62 +18,70 @@
  */ 
 package de.catma.document.source.contenthandler;
 
-import java.io.IOException;
-import java.io.InputStream;
-
 import de.catma.document.source.FileType;
 import de.catma.document.source.SourceDocument;
 import de.catma.document.source.SourceDocumentInfo;
+import de.catma.document.source.TechInfoSet;
+
+import java.io.IOException;
 
 /**
- * A content handler for a source document. The content handler is responsible for
- * loading content from a source document and keeping it in memory.
+ * A content handler for a {@link SourceDocument}. It is responsible for loading content from a source document and keeping it in memory.
  * <p>
  * It uses the proper encoding and {@link FileType}.
- * <p>
- * <strong>SourceContentHandler implementations need to have a default no-arg constructor!</strong>
  */
 public interface SourceContentHandler {
-
 	/**
-	 * @param sourceDocumentInfo all the metadata for the {@link SourceDocument}, has
-	 * to be set right after instance creation completed
+	 * Sets all the metadata for the source document with which this instance is associated. Must be called immediately after instantiation.
+	 *
+	 * @param sourceDocumentInfo a {@link SourceDocumentInfo} object containing the metadata
 	 */
-	public void setSourceDocumentInfo(
-			SourceDocumentInfo sourceDocumentInfo);
-	
+	void setSourceDocumentInfo(SourceDocumentInfo sourceDocumentInfo);
+
 	/**
-	 * @return all the metadata for the {@link SourceDocument}
+	 * Returns all the metadata for the source document with which this instance is associated.
+	 *
+	 * @return a {@link SourceDocumentInfo} object containing the metadata
 	 */
-	public SourceDocumentInfo getSourceDocumentInfo();
-	
+	SourceDocumentInfo getSourceDocumentInfo();
+
 	/**
-	 * @param is the {@link SourceDocument} as raw data.
-	 * @throws IOException error accessing the input stream.
+	 * Loads the content of the source document with which this instance is associated.
+	 * <p>
+	 * Loading is performed from the resource identified via {@link TechInfoSet#getURI()} of the {@link SourceDocumentInfo}.
+	 *
+	 * @throws IOException if an error occurs while loading the content
 	 */
-	public void load(InputStream is) throws IOException;
+	void load() throws IOException;
+
 	/**
-	 * Loading via {@link de.catma.document.source.TechInfoSet#getURI()} of the {@link SourceDocumentInfo}.
-	 * @throws IOException error accessing {@link de.catma.document.source.TechInfoSet#getURI()}.
+	 * Returns the content of the source document with which this instance is associated.
+	 *
+	 * @return the entire document text
+	 * @throws IOException if an error occurs while loading the content
 	 */
-	public void load() throws IOException;
-	
+	String getContent() throws IOException;
+
 	/**
-	 * @return the extracted text of the {@link SourceDocument}.
-	 * @throws IOException
+	 * Discards the content of the source document with which this instance is associated.
 	 */
-	public String getContent() throws IOException;
-	
+	void unload();
+
 	/**
-	 * Discards the content.
+	 * Whether the content of the source document with which this instance is associated has been loaded.
+	 *
+	 * @return <code>true</code> if the content has been loaded, <code>false</code> if the content has not yet been loaded or was unloaded via
+	 *         {@link SourceContentHandler#unload()}
 	 */
-	public void unload();
-	
+	boolean isLoaded();
+
 	/**
-	 * @return <code>true</code> if the content has been loaded and not yet unloaded, else <code>false</code>.
+	 * Whether the source document with which this instance is associated contains embedded annotations.
+	 * <p>
+	 * Can only be true for XML documents.
+	 *
+	 * @return <code>true</code> if embedded annotations exist, otherwise <code>false</code>
 	 */
-	public boolean isLoaded();
-	
-	public boolean hasIntrinsicMarkupCollection();
-	
+	@Deprecated
+	boolean hasIntrinsicAnnotationCollection();
 }