SubtermPattern (Sub-Term Mapping Tools API, 2015 Version)

java.lang.Object
- gov.nih.nlm.nls.stmt.Pattern.SubtermPattern

```
public class SubtermPattern
extends java.lang.Object
```
This program is Java Object for subterm pattern. Subterms are: - a subset of the input term - in the corpus tree One subterm pattern includes multiple subtermPatternElements. a pattern is a combination of subterm in the inTerm that in the tree (corpus) a term could have multilple patterns. Example: - inTerm: let dog and cat out - pattern 1 index|subterm|start index|end index|flag 0|let|0|1|false 1|dog|1|2|true 2|and|2|3|false 3|cat|3|4|true 0|out|4|5|false - pattern 2 index|subterm|start index|end index|flag 0|let|0|1|false 1|dog and cat|1|4|true 2|out|4|5|false where: dog, cat, dog and cat are subterms in the corpus
History:
Version:

V-2015

Author:

NLM NLS Development Team

Constructor Summary

Constructors
Constructor and Description
`SubtermPattern()` Create a subterm pattern by default value.
`SubtermPattern(java.util.Vector<SubtermPatternElement> pattern)` Create a subterm pattern by specifying the subterm pattern.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`Add(SubtermPatternElement subtermPatternElement)` Add a SubtermPatternElement to the subterm pattern.
`boolean`	`equals(java.lang.Object obj)` Equals methods for subterm pattern.
`int`	`GetLastPeEndIndex()` Get the ending index of the last pattern element.
`java.util.Vector<SubtermPatternElement>`	`GetPattern()` Get the subterm pattern - a collection of subterm pattern elements.
`int`	`GetPeEndIndexAt(int index)` Get the ending index of pattern element (index)
`int`	`GetPeStartIndexAt(int index)` Get the starting index of pattern element (index)
`int`	`GetSize()` Get the total number of subterm pattern elements in the subterm pattern.
`int`	`GetSubtermNo()` Get the total number of subterm in the subterm pattern.
`int`	`GetWordCount()` Get the total words count of pattern.
`int`	`hashCode()` Get the hash value of the subterm pattern.
`static void`	`main(java.lang.String[] args)` test driver for this class.
`java.lang.String`	`ToString()` Get the string representation of the subterm pattern

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

- Constructor Detail
  - SubtermPattern
```
public SubtermPattern()
```
    Create a subterm pattern by default value.
  - SubtermPattern
```
public SubtermPattern(java.util.Vector<SubtermPatternElement> pattern)
```
    Create a subterm pattern by specifying the subterm pattern.
    
    Parameters:
    pattern - the subterm pattern
- Method Detail
  - GetPattern
```
public java.util.Vector<SubtermPatternElement> GetPattern()
```
    Get the subterm pattern - a collection of subterm pattern elements.
    
    Returns:
    the subterm pattern
  - GetSubtermNo
```
public int GetSubtermNo()
```
    Get the total number of subterm in the subterm pattern. Subterms are subterm pattern elements with subterm flag is true.
    
    Returns:
    the total number of subterms
  - GetSize
```
public int GetSize()
```
    Get the total number of subterm pattern elements in the subterm pattern.
    
    Returns:
    the total number of subterm pattern elements
  - Add
```
public void Add(SubtermPatternElement subtermPatternElement)
```
    Add a SubtermPatternElement to the subterm pattern. This method also update subtermNo when the PE is a subterm.
    
    Parameters:
    subtermPatternElement - the subterm pattern element to be added
  - GetWordCount
```
public int GetWordCount()
```
    Get the total words count of pattern. Some PE might have multiple words.
    
    Returns:
    the total words count of pattern
  - GetPeStartIndexAt
```
public int GetPeStartIndexAt(int index)
```
    Get the starting index of pattern element (index)
    
    Parameters:
    index - the index of Pattern Element (PE)
    
    Returns:
    the starting position of the PE at index
  - GetPeEndIndexAt
```
public int GetPeEndIndexAt(int index)
```
    Get the ending index of pattern element (index)
    
    Parameters:
    index - the index of Pattern Element (PE)
    
    Returns:
    the ending position of the PE at index
  - GetLastPeEndIndex
```
public int GetLastPeEndIndex()
```
    Get the ending index of the last pattern element. This value is the same as the word count.
    
    Returns:
    the ending index of the last PE.
  - ToString
```
public java.lang.String ToString()
```
    Get the string representation of the subterm pattern
    
    Returns:
    the subterm pattern in string format
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Equals methods for subterm pattern. Override equals method for contains to use.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    obj - the subterm pattern to be compared
    
    Returns:
    true if equal, false if otherwise
  - hashCode
```
public int hashCode()
```
    Get the hash value of the subterm pattern. Must override for sort( ) and hashtable( )
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    the hash value of the subterm pattern
  - main
```
public static void main(java.lang.String[] args)
```
    test driver for this class.
    
    Parameters:
    args - arguments

Class SubtermPattern

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SubtermPattern

SubtermPattern

Method Detail

GetPattern

GetSubtermNo

GetSize

Add

GetWordCount

GetPeStartIndexAt

GetPeEndIndexAt

GetLastPeEndIndex

ToString

equals

hashCode

main