Propbank (ClearTK 2.0.0 API)

java.lang.Object
- org.cleartk.corpus.propbank.util.Propbank

```
@Beta
public class Propbank
extends Object
```
Copyright (c) 2007-2008, Regents of the University of Colorado
All rights reserved.
A Propbank object represents one entry in Propbank. It closely reflects the structure of one line in prop.txt.

Author:

Philipp Wetzler, Philip Ogren, Steven Bethard

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`baseForm`
`protected String`	`filename`
`protected String`	`frameSet`
`protected String`	`inflectionValue`
`protected List<Proplabel>`	`proplabels`
`protected String`	`propTxt`
`protected int`	`sentenceNumber`
`protected String`	`taggerName`
`protected PropbankRelation`	`terminal`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Propbank()

Constructors
Modifier	Constructor and Description
`protected`	`Propbank()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addProplabel(Proplabel proplabel)`
`org.cleartk.srl.type.Predicate`	`convert(JCas view, org.cleartk.syntax.constituent.type.TopTreebankNode topNode, org.cleartk.token.type.Sentence sentence)` Convert to ClearTK Predicate / SemanticArgument annotations and add them to view.
`String`	`displayText()` Generate an easily readable multi-line description of this Propbank entry.
`static String`	`filenameFromString(String propTxt)` A convenience funtion to quickly read only the filename portion of a line from `prop.txt`.
`static Propbank`	`fromString(String propTxt)` Parses one Propbank entry and returns its representation as a Propbank object.
`String`	`getBaseForm()`
`String`	`getFilename()`
`String`	`getFrameSet()`
`String`	`getInflectionValue()`
`List<Proplabel>`	`getPropLabels()`
`String`	`getPropTxt()`
`int`	`getSentenceNumber()`
`String`	`getTaggerName()`
`PropbankRelation`	`getTerminal()`
`void`	`setBaseForm(String baseForm)`
`void`	`setFilename(String filename)`
`void`	`setFrameSet(String frameSet)`
`void`	`setInflectionValue(String inflectionValue)`
`void`	`setPropLabels(List<Proplabel> proplabels)`
`void`	`setPropTxt(String propTxt)`
`void`	`setSentenceNumber(int sentenceNumber)`
`void`	`setTaggerName(String taggerName)`
`void`	`setTerminal(PropbankRelation terminal)`
`String`	`toString()` Re-generate the Propbank format line that this object was parsed from.

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

Field Detail

baseForm
```
protected String baseForm
```

filename
```
protected String filename
```

frameSet
```
protected String frameSet
```

inflectionValue
```
protected String inflectionValue
```

proplabels
```
protected List<Proplabel> proplabels
```

propTxt
```
protected String propTxt
```

sentenceNumber
```
protected int sentenceNumber
```

taggerName
```
protected String taggerName
```

terminal
```
protected PropbankRelation terminal
```

Constructor Detail
- Propbank
```
protected Propbank()
```

Method Detail

addProplabel

public void addProplabel(Proplabel proplabel)

convert
```
public org.cleartk.srl.type.Predicate convert(JCas view,
                                     org.cleartk.syntax.constituent.type.TopTreebankNode topNode,
                                     org.cleartk.token.type.Sentence sentence)
```
Convert to ClearTK Predicate / SemanticArgument annotations and add them to view.

Parameters:
view - the view where the annotations should be added
topNode - the top node annotation of the corresponding Treebank parse
sentence - the sentence annotation of the corresponding sentence

Returns:
the generated Predicate annotation

displayText
```
public String displayText()
```
Generate an easily readable multi-line description of this Propbank entry.

filenameFromString
```
public static String filenameFromString(String propTxt)
```
A convenience funtion to quickly read only the filename portion of a line from prop.txt.

Parameters:
propTxt - one line from prop.txt

Returns:
the filename part of propTxt

fromString
```
public static Propbank fromString(String propTxt)
```
Parses one Propbank entry and returns its representation as a Propbank object.

Parameters:
propTxt - one line from prop.txt

Returns:
a Propbank object representing propTxt

getBaseForm
```
public String getBaseForm()
```

getFilename
```
public String getFilename()
```

getFrameSet
```
public String getFrameSet()
```

getInflectionValue
```
public String getInflectionValue()
```

getPropLabels

public List<Proplabel> getPropLabels()

getPropTxt
```
public String getPropTxt()
```

getSentenceNumber
```
public int getSentenceNumber()
```

getTaggerName
```
public String getTaggerName()
```

getTerminal
```
public PropbankRelation getTerminal()
```

setBaseForm

public void setBaseForm(String baseForm)

setFilename

public void setFilename(String filename)

setFrameSet

public void setFrameSet(String frameSet)

setInflectionValue

public void setInflectionValue(String inflectionValue)

setPropLabels

public void setPropLabels(List<Proplabel> proplabels)

setPropTxt

public void setPropTxt(String propTxt)

setSentenceNumber

public void setSentenceNumber(int sentenceNumber)

setTaggerName

public void setTaggerName(String taggerName)

setTerminal

public void setTerminal(PropbankRelation terminal)

toString
```
public String toString()
```
Re-generate the Propbank format line that this object was parsed from.

Overrides:

toString in class Object

Class Propbank

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

baseForm

filename

frameSet

inflectionValue

proplabels

propTxt

sentenceNumber

taggerName

terminal

Constructor Detail

Propbank

Method Detail

addProplabel

convert

displayText

filenameFromString

fromString

getBaseForm

getFilename

getFrameSet

getInflectionValue

getPropLabels

getPropTxt

getSentenceNumber

getTaggerName

getTerminal

setBaseForm

setFilename

setFrameSet

setInflectionValue

setPropLabels

setPropTxt

setSentenceNumber

setTaggerName

setTerminal

toString