XcasFile (Apache cTAKES 4.0.0 API)

java.lang.Object
- org.apache.ctakes.utils.xcas_comparison.XcasFile

All Implemented Interfaces:

Cloneable
```
public class XcasFile
extends Object
implements Cloneable
```
An XcasFile wraps all XcasAnnotationss in it and also contains their position information in terms of line and column numbers.

Author:

Mayo Clinic

Field Summary

Fields
Modifier and Type Field and Description

protected Hashtable<Integer,XcasAnnotation> annotations

protected File f

protected Hashtable<XcasAnnotation,String> positions

Fields
Modifier and Type	Field and Description
`protected Hashtable<Integer,XcasAnnotation>`	`annotations`
`protected File`	`f`
`protected Hashtable<XcasAnnotation,String>`	`positions`

Constructor Summary

Constructors
Constructor and Description
`XcasFile()` Default constructor.
`XcasFile(File f)` Constructs an `XcasFile` with the specified name.
`XcasFile(String f)` Constructs an `XcasFile` with the specified name.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAnnotation(int id, XcasAnnotation a)` Inserts a new annotation with the specified internal `id` to this `XcasFile`.
`void`	`addAnnotation(int id, XcasAnnotation a, int lineNum, int colNum)` Inserts a new annotation, along with its position in the file, to this `XcasFile` object.
`void`	`addAnnotation(int id, XcasAnnotation a, String pos)` Inserts a new annotation, along with its position in the file, to this `XcasFile` object.
`LinkedList<XcasAnnotation>`	`annotationsClone()`
`Object`	`clone()`
`boolean`	`equals(Object obj)` Checks whether the specified object has the same set of annotations.
`Collection<XcasAnnotation>`	`getAllAnnotations()`
`XcasAnnotation`	`getAnnotation(int id)` Returns the `XcasAnnotation` object associated with the specified internal id.
`String`	`getFileName()`
`String`	`getPosition(XcasAnnotation a)` Returns the line and column numbers of the specified `XcasAnnotation`.
`String`	`getPositionOther(XcasAnnotation a)` Finds an `XcasAnnotation` with the same attributes as specified, and returns its line and column numbers.
`String`	`getPositionOwn(int id)` Returns the line and column numbers of the `XcasAnnotation`, specified by the original XCAS internal `_id` field.
`String`	`getPositionOwn(XcasAnnotation a)` Returns the line and column numbers of the specified `XcasAnnotation`, which is included in this `XcasFile` object.
`String`	`getPositionSimilar(XcasAnnotation a)` Finds an `XcasAnnotation` of the same type as specified, and a same text span, then returns its line and column number.
`boolean`	`hasAnnotation(int id)` Checks whether this XCAS file has an annotation with the specified id.
`boolean`	`hasAnnotation(XcasAnnotation a)` Checks whether this XCAS file has the specified `XcasAnnotation`.
`static XcasFile`	`process(String f)` Creates a new `XcasFile` object from the specified file.

Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - f
```
protected File f
```
  - annotations
```
protected Hashtable<Integer,XcasAnnotation> annotations
```
  - positions
```
protected Hashtable<XcasAnnotation,String> positions
```
- Constructor Detail
  - XcasFile
```
public XcasFile()
```
    Default constructor.
  - XcasFile
```
public XcasFile(String f)
```
    Constructs an XcasFile with the specified name.
    
    Parameters:
    
    f - File name.
  - XcasFile
```
public XcasFile(File f)
```
    Constructs an XcasFile with the specified name.
    
    Parameters:
    
    f - A File object.
- Method Detail
  - process
```
public static XcasFile process(String f)
```
    Creates a new XcasFile object from the specified file. Avoid using this method if you plan to parse multiple files, as this method creates an anonymous XcasProcessor instance each time called, which could be used to parse multiple files.
    
    Parameters:
    
    f - A string containing the XCAS file name.
    
    Returns:
    
    A parsed XcasFile object.
  - addAnnotation
```
public void addAnnotation(int id,
                          XcasAnnotation a)
```
    Inserts a new annotation with the specified internal id to this XcasFile.
    
    Parameters:
    
    id - UIMA CAS internal _id.
    
    a - An XcasAnnotation object to add.
    
    See Also:
    
    addAnnotation(int, XcasAnnotation, String), addAnnotation(int, XcasAnnotation, int, int)
  - addAnnotation
```
public void addAnnotation(int id,
                          XcasAnnotation a,
                          String pos)
```
    Inserts a new annotation, along with its position in the file, to this XcasFile object.
    
    Parameters:
    
    id - UIMA CAS internal _id.
    
    a - An XcasAnnotation object to add.
    
    pos - Line and column number of the specified annotation, in the form of line_number:column_number.
  - addAnnotation
```
public void addAnnotation(int id,
                          XcasAnnotation a,
                          int lineNum,
                          int colNum)
```
    Inserts a new annotation, along with its position in the file, to this XcasFile object.
    
    Parameters:
    
    id - UIMA CAS internal _id.
    
    a - An XcasAnnotation object to add.
    
    lineNum - Line number of the specified annotation.
    
    colNum - Column number of the specified annotation.
  - getAnnotation
```
public XcasAnnotation getAnnotation(int id)
```
    Returns the XcasAnnotation object associated with the specified internal id.
    
    Parameters:
    
    id - UIMA CAS internal _id.
    
    Returns:
    
    The XcasAnnotation with the specified id.
  - getAllAnnotations
```
public Collection<XcasAnnotation> getAllAnnotations()
```
  - getFileName
```
public String getFileName()
```
  - getPositionOwn
```
public String getPositionOwn(XcasAnnotation a)
```
    Returns the line and column numbers of the specified XcasAnnotation, which is included in this XcasFile object.
    
    Returns:
    
    A string containing the line and column numbers of the specified object, in the form of line_number:column_number.
    
    See Also:
    
    getPositionOwn(int), getPositionOther(XcasAnnotation)
  - getPositionOwn
```
public String getPositionOwn(int id)
```
    Returns the line and column numbers of the XcasAnnotation, specified by the original XCAS internal _id field.
    
    Parameters:
    
    id - UIMA CAS internal _id.
    
    Returns:
    
    A string containing the line and column numbers of the specified object, in the form of line_number:column_number.
    
    See Also:
    
    getPositionOwn(XcasAnnotation), getPositionOther(XcasAnnotation)
  - getPositionOther
```
public String getPositionOther(XcasAnnotation a)
```
    Finds an XcasAnnotation with the same attributes as specified, and returns its line and column numbers.
    
    Returns:
    
    A string containing the line and column numbers of the specified object, in the form of line_number:column_number.
    
    See Also:
    
    getPositionOwn(int), getPositionOwn(XcasAnnotation)
  - getPosition
```
public String getPosition(XcasAnnotation a)
```
    Returns the line and column numbers of the specified XcasAnnotation.
    Do not use this method if you know the specified XcasAnnotation object is in this XcasFile. Instead, use getPositionOwn(XcasAnnotation), which is faster.
    
    Parameters:
    
    a - An
    
    Returns:
    
    A string containing the line and column numbers of the specified object, in the form of line_number:column_number.
    
    See Also:
    
    getPositionOwn(XcasAnnotation), getPositionOther(XcasAnnotation)
  - getPositionSimilar
```
public String getPositionSimilar(XcasAnnotation a)
```
    Finds an XcasAnnotation of the same type as specified, and a same text span, then returns its line and column number.
    
    Parameters:
    
    a - An XcasAnnotation against which a similar XcasAnnotation in this XcasFile is to be matched.
    
    Returns:
    
    A string containing the line and column numbers of the specified object, in the form of line_number:column_number.
    
    See Also:
    
    getPositionOther(XcasAnnotation)
  - hasAnnotation
```
public boolean hasAnnotation(int id)
```
    Checks whether this XCAS file has an annotation with the specified id.
    
    Parameters:
    
    id - UIMA CAS internal _id.
    
    Returns:
    
    true if file has an annotation with the specified id, false otherwise.
  - hasAnnotation
```
public boolean hasAnnotation(XcasAnnotation a)
```
    Checks whether this XCAS file has the specified XcasAnnotation. If there is an XcasAnnotation object that has exactly the same type, attributes, and references, return true.
    
    Parameters:
    
    a - An XcasAnnotation to check.
    
    Returns:
    
    true if there is one XcasAnnotation equals the specified one, false otherwise.
    
    See Also:
    
    XcasAnnotation.equals(Object)
  - equals
```
public boolean equals(Object obj)
```
    Checks whether the specified object has the same set of annotations. First check whether the specified is an XcasFile object. If so, check whether its annotation set is of the same size as in this XcasFile, then check whether these two sets are equal.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - An object to compare to.
    
    Returns:
    
    true if the specified object is an XcasFile object and has a same set of XcasAnnotations, false otherwise.
  annotationsClone public LinkedList<XcasAnnotation> annotationsClone() clone public Object clone() Overrides: clone in class Object

Class XcasFile

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

f

annotations

positions

Constructor Detail

XcasFile

XcasFile

XcasFile

Method Detail

process

addAnnotation

addAnnotation

addAnnotation

getAnnotation

getAllAnnotations

getFileName

getPositionOwn

getPositionOwn

getPositionOther

getPosition

getPositionSimilar

hasAnnotation

hasAnnotation

equals

annotationsClone

clone