Package org.apache.uima.caseditor.editor

Class DocumentUimaImpl

java.lang.Object

org.apache.uima.caseditor.editor.AbstractDocument

org.apache.uima.caseditor.editor.DocumentUimaImpl

All Implemented Interfaces:

ICasDocument

public class DocumentUimaImpl
extends AbstractDocument

This document implementation is based on an uima cas object.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JAVA_NATURE	The Constant JAVA_NATURE.

Constructor Summary

Constructors

Constructor	Description
DocumentUimaImpl(CAS cas, org.eclipse.core.resources.IFile casFile, String typeSystemText)	Initializes a new instance.

Method Summary

Modifier and Type	Method	Description
void	addFeatureStructure(FeatureStructure annotation)	Adds the given annotation to the CAS.
void	addFeatureStructures(Collection<? extends FeatureStructure> annotations)	Adds the FeatureStructures.
void	changed()	The document was changed.
Collection<AnnotationFS>	getAnnotations(Type type)	Retrieves annotations of the given type from the CAS.
CAS	getCAS()	Retrieves the CAS.
static ClassLoader	getProjectClassLoader(org.eclipse.core.resources.IProject project)	Gets the project class loader.
Type	getType(String type)	Retrieves the given type from the TypeSystem.
String	getTypeSystemText()	Retrieves the string representation of the applied type system.
static CAS	getVirginCAS(org.eclipse.core.resources.IFile extensionTypeSystemFile)	Gets the virgin CAS.
void	removeFeatureStructure(FeatureStructure annotation)	Removes the annotations from the CAS.
void	removeFeatureStructures(Collection<? extends FeatureStructure> annotationsToRemove)	Removes the given annotations from the CAS.
void	serialize(OutputStream out)	Serializes the CAS to the given OutputStream in the XCAS format.
void	switchView(String viewName)	Switches the view of the underlying CAS to the provided view name.
void	update(FeatureStructure annotation)	Notifies clients about the changed annotation.
void	updateFeatureStructure(Collection<? extends FeatureStructure> annotations)	Notifies clients about the changed annotation.

Methods inherited from class org.apache.uima.caseditor.editor.AbstractDocument

addChangeListener, fireAddedFeatureStructure, fireAddedFeatureStructure, fireChanged, fireRemovedFeatureStructure, fireRemovedFeatureStructure, fireUpdatedFeatureStructure, fireUpdatedFeatureStructure, fireViewChanged, removeChangeListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

JAVA_NATURE

public static final String JAVA_NATURE

The Constant JAVA_NATURE.

See Also:

• Constant Field Values

Constructor Details

DocumentUimaImpl

public DocumentUimaImpl(CAS cas,
 org.eclipse.core.resources.IFile casFile,
 String typeSystemText)
                 throws org.eclipse.core.runtime.CoreException

Initializes a new instance.

Parameters:

cas - the cas

casFile - the cas file

typeSystemText - type system string

Throws:

org.eclipse.core.runtime.CoreException - the core exception

Method Details

getCAS

public CAS getCAS()

Retrieves the CAS.

Returns:

the cas

getTypeSystemText

public String getTypeSystemText()

Description copied from interface: ICasDocument

Retrieves the string representation of the applied type system.

Specified by:

getTypeSystemText in interface ICasDocument

Overrides:

getTypeSystemText in class AbstractDocument

Returns:

the string representation of the applied type system

addFeatureStructure

public void addFeatureStructure(FeatureStructure annotation)

Adds the given annotation to the CAS.

Parameters:

annotation - the annotation

addFeatureStructures

public void addFeatureStructures(Collection<? extends FeatureStructure> annotations)

Description copied from interface: ICasDocument

Adds the FeatureStructures.

Parameters:

annotations - the structures

removeFeatureStructure

public void removeFeatureStructure(FeatureStructure annotation)

Removes the annotations from the CAS.

Parameters:

annotation - the annotation

removeFeatureStructures

public void removeFeatureStructures(Collection<? extends FeatureStructure> annotationsToRemove)

Removes the given annotations from the CAS.

Parameters:

annotationsToRemove - the annotations to remove

update

public void update(FeatureStructure annotation)

Notifies clients about the changed annotation.

Parameters:

annotation - the annotation

updateFeatureStructure

public void updateFeatureStructure(Collection<? extends FeatureStructure> annotations)

Notifies clients about the changed annotation.

Parameters:

annotations - the annotations

changed

public void changed()

Description copied from interface: ICasDocument

The document was changed. Its unknown what changed.

getAnnotations

public Collection<AnnotationFS> getAnnotations(Type type)

Retrieves annotations of the given type from the CAS.

Parameters:

type - the type

Returns:

the annotations

getType

public Type getType(String type)

Retrieves the given type from the TypeSystem.

Parameters:

type - the type

Returns:

the type

switchView

public void switchView(String viewName)

Description copied from interface: ICasDocument

Switches the view of the underlying CAS to the provided view name.

Parameters:

viewName - the view name

serialize

public void serialize(OutputStream out)
               throws org.eclipse.core.runtime.CoreException

Serializes the CAS to the given OutputStream in the XCAS format.

Parameters:

out - the out

Throws:

org.eclipse.core.runtime.CoreException - the core exception

getVirginCAS

public static CAS getVirginCAS(org.eclipse.core.resources.IFile extensionTypeSystemFile)
                        throws org.eclipse.core.runtime.CoreException

Gets the virgin CAS.

Parameters:

extensionTypeSystemFile - the type system file

Returns:

the virgin CAS

Throws:

org.eclipse.core.runtime.CoreException - the core exception

getProjectClassLoader

public static ClassLoader getProjectClassLoader(org.eclipse.core.resources.IProject project)
                                         throws org.eclipse.core.runtime.CoreException

Gets the project class loader.

Parameters:

project - the project

Returns:

the project class loader

Throws:

org.eclipse.core.runtime.CoreException - the core exception