grammarscope.mutable.MutableGrammaticalRelation Class Reference

Inheritance diagram for grammarscope.mutable.MutableGrammaticalRelation:

Collaboration diagram for grammarscope.mutable.MutableGrammaticalRelation:

Public Member Functions
	MutableGrammaticalRelation (final String name, final String shortName, final String longName, final ProtoGrammaticalRelation parent, final String sourcePatternString, final String[] targetPatternStrings)
	MutableGrammaticalRelation (final String name, final String shortName, final String longName, final ProtoGrammaticalRelation parent, final String sourcePatternString, final String[] targetPatternStrings, final String description, final String[][] codedExamples)
MutableGrammaticalRelation	copy ()
void	addChild (final ProtoGrammaticalRelation child)
void	removeChild (final ProtoGrammaticalRelation child)
MutableGrammaticalRelation	getParent ()
Iterable< MutableGrammaticalRelation >	getChildrenIterable ()
Iterator< MutableGrammaticalRelation >	getChildrenIterator ()
String	getId ()
String	getName ()
String	getDescription ()
String[][]	getCodedExamples ()
void	setShortName (final String shortName)
void	setLongName (final String longName)
void	setSpecific (final String specific)
void	setName (final String name)
void	setDescription (final String description)
void	setParent (final ProtoGrammaticalRelation parent)
void	setChildren (final List< ProtoGrammaticalRelation > children)
void	setSourcePattern (final Pattern sourcePattern)
void	setTargetPatterns (final List< TregexPattern > targetPatterns)
void	setCodedExamples (final String[][] codedExamples)
String	getTreeName (final boolean down, final boolean displayLongName)
String	getLineage (final boolean down, final boolean displayLongName)
String[]	getTargetPatternStrings ()
void	walkTree (final IMutableRelationProcessor processor)
Public Member Functions inherited from grammarscope.mutable.ProtoGrammaticalRelation
boolean	isFromString ()
	ProtoGrammaticalRelation (final String shortName, final String longName, final ProtoGrammaticalRelation parent, final String sourcePattern, final String[] targetPatterns, final String specificString)
Collection< Tree >	getRelatedNodes (final Tree tree, final Tree root)
boolean	isApplicable (final Tree tree)
boolean	isAncestor (final ProtoGrammaticalRelation gr0)
final String	toString ()
String	getLongName ()
String	getShortName ()
String	getSpecific ()
List<? extends ProtoGrammaticalRelation >	getChildren ()
Pattern	getSourcePattern ()
List< TregexPattern >	getTargetPatterns ()

Static Public Member Functions
static Pattern	getSourcePattern (final List< TregexPattern > patterns)
static String[]	getTargetPatternStrings (final List< TregexPattern > patterns)
static String	patternToString (final TregexPattern pattern)
static void	main (final String[] args)
Static Public Member Functions inherited from grammarscope.mutable.ProtoGrammaticalRelation
static List< TregexPattern >	compileTargetPatterns (final String[] patternStrings)

Private Member Functions
	MutableGrammaticalRelation (final String name, final String shortName, final String longName, final ProtoGrammaticalRelation parent, final Pattern sourcePattern, final List< TregexPattern > targetPatterns, final String description, final String[][] codedExamples)

Private Attributes
String	name
String	description
String[][]	codedExamples

Static Private Attributes
static final long	serialVersionUID = 3L

Additional Inherited Members
Protected Attributes inherited from grammarscope.mutable.ProtoGrammaticalRelation
String	shortName
String	longName
ProtoGrammaticalRelation	parent
List< ProtoGrammaticalRelation >	children = new ArrayList<>()
Pattern	sourcePattern
List< TregexPattern >	targetPatterns = new ArrayList<>()
String	specific

Detailed Description

Mutable (editable) grammatical relation

Author

Bernard Bou

Constructor & Destructor Documentation

MutableGrammaticalRelation() [1/3]

grammarscope.mutable.MutableGrammaticalRelation.MutableGrammaticalRelation	(	final String	name,
		final String	shortName,
		final String	longName,
		final ProtoGrammaticalRelation	parent,
		final String	sourcePatternString,
		final String[]	targetPatternStrings
	)

Constructor

Parameters

name	name
shortName	short name
longName	long name
parent	parent relation
sourcePatternString	uncompiled source pattern
targetPatternStrings	uncompiled target patterns

MutableGrammaticalRelation() [2/3]

grammarscope.mutable.MutableGrammaticalRelation.MutableGrammaticalRelation	(	final String	name,
		final String	shortName,
		final String	longName,
		final ProtoGrammaticalRelation	parent,
		final String	sourcePatternString,
		final String[]	targetPatternStrings,
		final String	description,
		final String	codedExamples[][]
	)

Constructor

Parameters

name	name
shortName	short name
longName	long name
parent	parent relation
sourcePatternString	uncompiled source pattern
targetPatternStrings	uncompiled target patterns
description	description
codedExamples	examples

MutableGrammaticalRelation() [3/3]

grammarscope.mutable.MutableGrammaticalRelation.MutableGrammaticalRelation ( final String  name, final String  shortName, final String  longName, final ProtoGrammaticalRelation  parent, final Pattern  sourcePattern, final List< TregexPattern >  targetPatterns, final String  description, final String  codedExamples[][]  )

private

Constructor

Parameters

name	name
shortName	short name
longName	long name
parent	parent relation
sourcePattern	compiled source pattern
targetPatterns	compiled target patterns
description	description
codedExamples	examples

Member Function Documentation

addChild()

void grammarscope.mutable.MutableGrammaticalRelation.addChild

(

final ProtoGrammaticalRelation

child

)

Reimplemented from grammarscope.mutable.ProtoGrammaticalRelation.

copy()

MutableGrammaticalRelation grammarscope.mutable.MutableGrammaticalRelation.copy

(

)

Clone

Returns

duplicated relation (unlinked from hierarchy)

getChildrenIterable()

Iterable<MutableGrammaticalRelation> grammarscope.mutable.MutableGrammaticalRelation.getChildrenIterable

(

)

Get child relations

Returns

children

getChildrenIterator()

Iterator<MutableGrammaticalRelation> grammarscope.mutable.MutableGrammaticalRelation.getChildrenIterator

(

)

Get child iterator

Returns

child iterator

getCodedExamples()

String [][] grammarscope.mutable.MutableGrammaticalRelation.getCodedExamples

(

)

Get coded examples

Returns

coded examples

getDescription()

String grammarscope.mutable.MutableGrammaticalRelation.getDescription

(

)

Get description

Returns

description

getId()

String grammarscope.mutable.MutableGrammaticalRelation.getId

(

)

Get id

Returns

id

getLineage()

String grammarscope.mutable.MutableGrammaticalRelation.getLineage	(	final boolean	down,
		final boolean	displayLongName
	)

Get up lineage (parents to root)

Parameters

down	parent-child order
displayLongName	whether to display long names

Returns

lineage string

getName()

String grammarscope.mutable.MutableGrammaticalRelation.getName

(

)

Get name

Returns

name

getParent()

MutableGrammaticalRelation grammarscope.mutable.MutableGrammaticalRelation.getParent

(

)

Get parent relation

Returns

parent relation

Reimplemented from grammarscope.mutable.ProtoGrammaticalRelation.

getSourcePattern()

static Pattern grammarscope.mutable.MutableGrammaticalRelation.getSourcePattern ( final List< TregexPattern >  patterns )

static

Extract source pattern from target patterns

Parameters

patterns

target patterns

Returns

source pattern

getTargetPatternStrings() [1/2]

String [] grammarscope.mutable.MutableGrammaticalRelation.getTargetPatternStrings

(

)

getTargetPatternStrings() [2/2]

static String [] grammarscope.mutable.MutableGrammaticalRelation.getTargetPatternStrings ( final List< TregexPattern >  patterns )

static

Stringify target patterns

Parameters

patterns

patterns

Returns

pattern strings

getTreeName()

String grammarscope.mutable.MutableGrammaticalRelation.getTreeName	(	final boolean	down,
		final boolean	displayLongName
	)

Get tree name (this node with appended lineage)

Parameters

down	parent-child order
displayLongName	whether to display long names

Returns

tree name string

main()

static void grammarscope.mutable.MutableGrammaticalRelation.main ( final String[]  args )

static

Dump

Parameters

args

arguments

patternToString()

static String grammarscope.mutable.MutableGrammaticalRelation.patternToString ( final TregexPattern  pattern )

static

Stringify pattern

Parameters

pattern

pattern to stringify

Returns

pattern string

removeChild()

void grammarscope.mutable.MutableGrammaticalRelation.removeChild

(

final ProtoGrammaticalRelation

child

)

Remove child from children array

Parameters

child

child to remove

setChildren()

void grammarscope.mutable.MutableGrammaticalRelation.setChildren

(

final List< ProtoGrammaticalRelation >

children

)

Set children

Parameters

children

children

setCodedExamples()

void grammarscope.mutable.MutableGrammaticalRelation.setCodedExamples

(

final String

codedExamples[][]

)

Set coded examples

Parameters

codedExamples

coded examples

setDescription()

void grammarscope.mutable.MutableGrammaticalRelation.setDescription

(

final String

description

)

Set description

Parameters

description

description

setLongName()

void grammarscope.mutable.MutableGrammaticalRelation.setLongName

(

final String

longName

)

Set long name

Parameters

longName

long name

setName()

void grammarscope.mutable.MutableGrammaticalRelation.setName

(

final String

name

)

Set name

Parameters

name

name

setParent()

void grammarscope.mutable.MutableGrammaticalRelation.setParent

(

final ProtoGrammaticalRelation

parent

)

Set parents

Parameters

parent

parent relation

setShortName()

void grammarscope.mutable.MutableGrammaticalRelation.setShortName

(

final String

shortName

)

Set short name

Parameters

shortName

short name

setSourcePattern()

void grammarscope.mutable.MutableGrammaticalRelation.setSourcePattern

(

final Pattern

sourcePattern

)

Set source pattern

Parameters

sourcePattern

source pattern

setSpecific()

void grammarscope.mutable.MutableGrammaticalRelation.setSpecific

(

final String

specific

)

Set specific

Parameters

specific

specific

setTargetPatterns()

void grammarscope.mutable.MutableGrammaticalRelation.setTargetPatterns

(

final List< TregexPattern >

targetPatterns

)

Set target patterns

Parameters

targetPatterns

compiled target patterns

walkTree()

void grammarscope.mutable.MutableGrammaticalRelation.walkTree

(

final IMutableRelationProcessor

processor

)

Walk relation tree

Parameters

processor

node processor

Member Data Documentation

codedExamples

String [][] grammarscope.mutable.MutableGrammaticalRelation.codedExamples

private

Example, the way the relation in the example is formalized. E.g. pred((Reagan,died) pairs

description

String grammarscope.mutable.MutableGrammaticalRelation.description

private

Description

name

String grammarscope.mutable.MutableGrammaticalRelation.name

private

Name

serialVersionUID

final long grammarscope.mutable.MutableGrammaticalRelation.serialVersionUID = 3L

staticprivate

---

The documentation for this class was generated from the following file:

• grammarscope/library-edit/src/main/java/grammarscope/mutable/MutableGrammaticalRelation.java