org.maltparser.core.lw.graph

Class LWDependencyGraph

java.lang.Object

org.maltparser.core.lw.graph.LWDependencyGraph

All Implemented Interfaces:

DependencyStructure, LabeledStructure, SecEdgeStructure, TokenStructure

public final class LWDependencyGraph
extends java.lang.Object
implements DependencyStructure

A lightweight version of org.maltparser.core.syntaxgraph.DependencyGraph.

Author:

Johan Hall

Constructor Summary

Constructors

Constructor and Description
LWDependencyGraph(org.maltparser.concurrent.graph.dataformat.DataFormat _dataFormat, SymbolTableHandler _symbolTables)
LWDependencyGraph(org.maltparser.concurrent.graph.dataformat.DataFormat _dataFormat, SymbolTableHandler _symbolTables, java.lang.String[] inputTokens, java.lang.String defaultRootLabel)
LWDependencyGraph(org.maltparser.concurrent.graph.dataformat.DataFormat _dataFormat, SymbolTableHandler _symbolTables, java.lang.String[] inputTokens, java.lang.String defaultRootLabel, boolean addEdges)

Method Summary

Modifier and Type	Method and Description
void	addComment(java.lang.String comment, int at_index)
Edge	addDependencyEdge(int headIndex, int dependentIndex) Adds an edge from the head to the dependent identified by the indices of the dependency nodes.
DependencyNode	addDependencyNode()
DependencyNode	addDependencyNode(int index)
void	addLabel(Element element, java.lang.String labelFunction, java.lang.String label) Adds a label label to the graph element element
Edge	addSecondaryEdge(ComparableNode source, ComparableNode target)
TokenNode	addTokenNode() Adds a token node with index n + 1, where n is the index of the last token node.
TokenNode	addTokenNode(int index) Adds a token node with index index.
void	checkInLabelSet(LabelSet labelSet) Checks in a label set.
LabelSet	checkOutNewLabelSet() Checks out a new label set from the structure.
void	clear() Resets the structure.
protected DependencyNode	findComponent(int nodeIndex)
java.util.ArrayList<java.lang.String>	getComment(int at_index)
org.maltparser.concurrent.graph.dataformat.DataFormat	getDataFormat()
int	getDefaultRootEdgeLabelCode(SymbolTable table) Returns the default edge label of the root as an integer value.
LabelSet	getDefaultRootEdgeLabels()
java.lang.String	getDefaultRootEdgeLabelSymbol(SymbolTable table) Returns the default edge label of the root as a string value.
java.util.SortedSet<java.lang.Integer>	getDependencyIndices() Returns a sorted set of integers {0,s,..n} , where each index i identifies a dependency node.
DependencyNode	getDependencyNode(int index) Returns the dependency node identified by index if it exists, otherwise null.
DependencyNode	getDependencyRoot() Returns the root of the dependency structure.
java.util.SortedSet<Edge>	getEdges()
int	getHighestDependencyNodeIndex()
int	getHighestTokenIndex() Returns the index of the last token node.
protected java.util.List<DependencyNode>	getListOfDependents(int nodeIndex)
protected java.util.List<DependencyNode>	getListOfLeftDependents(int nodeIndex)
protected java.util.List<DependencyNode>	getListOfRightDependents(int nodeIndex)
LWNode	getNode(int nodeIndex)
protected int	getRank(int nodeIndex)
int	getSentenceID() Returns the sentence ID
protected java.util.SortedSet<DependencyNode>	getSortedSetOfDependents(int nodeIndex)
protected java.util.SortedSet<DependencyNode>	getSortedSetOfLeftDependents(int nodeIndex)
protected java.util.SortedSet<DependencyNode>	getSortedSetOfRightDependents(int nodeIndex)
SymbolTableHandler	getSymbolTables() Returns the symbol table handler.
java.util.SortedSet<java.lang.Integer>	getTokenIndices() Returns a sorted set of integers {s,...
TokenNode	getTokenNode(int index) Returns the token node with index index.
boolean	hasComments()
protected boolean	hasDependent(int nodeIndex)
boolean	hasLabeledDependency(int index) Returns true if the head edge of the dependency node with index is labeled, otherwise false.
protected boolean	hasLeftDependent(int nodeIndex)
protected boolean	hasRightDependent(int nodeIndex)
boolean	hasTokens() Returns true if the token structure (sentence) has any token nodes, otherwise false.
boolean	isConnected() Returns true if all nodes in the dependency structure are connected, otherwise false.
boolean	isProjective() Returns true if all edges in the dependency structure are projective, otherwise false.
boolean	isSingleHeaded() Returns true if all dependency nodes have at most one incoming edge, otherwise false.
boolean	isTree() Returns true if the dependency structure are a tree (isConnected() && isSingleHeaded()), otherwise false.
void	linkAllTreesToRoot() Links all subtrees to the root of the dependency structure.
Edge	moveDependencyEdge(int newHeadIndex, int dependentIndex) Replace the head of the dependent with a new head.
int	nDependencyNode()
int	nEdges() Returns the number of edges
int	nNodes()
int	nNonProjectiveEdges() Returns the number of non-projective edges in the dependency structure.
int	nTokenNode() Returns the number of token nodes in the token structure (sentence).
void	removeDependencyEdge(int headIndex, int dependentIndex) Remove an edge from the head to the dependent identified by the indices of the dependency nodes.
void	removeSecondaryEdge(ComparableNode source, ComparableNode target)
void	resetTokens(java.lang.String[] inputTokens, java.lang.String defaultRootLabel, boolean addEdges)
void	setDefaultRootEdgeLabel(SymbolTable table, java.lang.String defaultRootSymbol) Sets the default edge label of the root.
void	setDefaultRootEdgeLabels(java.lang.String rootLabelOption, java.util.SortedMap<java.lang.String,SymbolTable> edgeSymbolTables) Sets the default edge label of the root according to the default root label option
void	setSentenceID(int sentenceID) Sets the sentence ID
void	setSymbolTables(SymbolTableHandler symbolTables) Sets the symbol table handler.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LWDependencyGraph

public LWDependencyGraph(org.maltparser.concurrent.graph.dataformat.DataFormat _dataFormat,
                         SymbolTableHandler _symbolTables)
                  throws MaltChainedException

Throws:

MaltChainedException

LWDependencyGraph

public LWDependencyGraph(org.maltparser.concurrent.graph.dataformat.DataFormat _dataFormat,
                         SymbolTableHandler _symbolTables,
                         java.lang.String[] inputTokens,
                         java.lang.String defaultRootLabel)
                  throws MaltChainedException

Throws:

MaltChainedException

LWDependencyGraph

public LWDependencyGraph(org.maltparser.concurrent.graph.dataformat.DataFormat _dataFormat,
                         SymbolTableHandler _symbolTables,
                         java.lang.String[] inputTokens,
                         java.lang.String defaultRootLabel,
                         boolean addEdges)
                  throws MaltChainedException

Throws:

MaltChainedException

Method Detail

resetTokens

public void resetTokens(java.lang.String[] inputTokens,
                        java.lang.String defaultRootLabel,
                        boolean addEdges)
                 throws MaltChainedException

Throws:

MaltChainedException

getDataFormat

public org.maltparser.concurrent.graph.dataformat.DataFormat getDataFormat()

getNode

public LWNode getNode(int nodeIndex)

nNodes

public int nNodes()

hasDependent

protected boolean hasDependent(int nodeIndex)

hasLeftDependent

protected boolean hasLeftDependent(int nodeIndex)

hasRightDependent

protected boolean hasRightDependent(int nodeIndex)

getListOfLeftDependents

protected java.util.List<DependencyNode> getListOfLeftDependents(int nodeIndex)

getSortedSetOfLeftDependents

protected java.util.SortedSet<DependencyNode> getSortedSetOfLeftDependents(int nodeIndex)

getListOfRightDependents

protected java.util.List<DependencyNode> getListOfRightDependents(int nodeIndex)

getSortedSetOfRightDependents

protected java.util.SortedSet<DependencyNode> getSortedSetOfRightDependents(int nodeIndex)

getListOfDependents

protected java.util.List<DependencyNode> getListOfDependents(int nodeIndex)

getSortedSetOfDependents

protected java.util.SortedSet<DependencyNode> getSortedSetOfDependents(int nodeIndex)

getRank

protected int getRank(int nodeIndex)

findComponent

protected DependencyNode findComponent(int nodeIndex)

addTokenNode

public TokenNode addTokenNode()
                       throws MaltChainedException

Description copied from interface: TokenStructure

Adds a token node with index n + 1, where n is the index of the last token node.

Specified by:

addTokenNode in interface TokenStructure

Returns:

the added token node.

Throws:

MaltChainedException

addTokenNode

public TokenNode addTokenNode(int index)
                       throws MaltChainedException

Description copied from interface: TokenStructure

Adds a token node with index index.

Specified by:

addTokenNode in interface TokenStructure

Parameters:

index - the index of the token node.

Returns:

the added token node.

Throws:

MaltChainedException

getTokenNode

public TokenNode getTokenNode(int index)

Description copied from interface: TokenStructure

Returns the token node with index index.

Specified by:

getTokenNode in interface TokenStructure

Parameters:

index - the index of the token node.

Returns:

a token node with index index.

addComment

public void addComment(java.lang.String comment,
                       int at_index)

Specified by:

addComment in interface TokenStructure

getComment

public java.util.ArrayList<java.lang.String> getComment(int at_index)

Specified by:

getComment in interface TokenStructure

hasComments

public boolean hasComments()

Specified by:

hasComments in interface TokenStructure

nTokenNode

public int nTokenNode()

Description copied from interface: TokenStructure

Returns the number of token nodes in the token structure (sentence).

Specified by:

nTokenNode in interface TokenStructure

Returns:

the number of token nodes in the token structure (sentence).

getTokenIndices

public java.util.SortedSet<java.lang.Integer> getTokenIndices()

Description copied from interface: TokenStructure

Returns a sorted set of integers {s,...,n}, where each index i identifies a token node. Index s is the first token node and index n is the last token node.

Specified by:

getTokenIndices in interface TokenStructure

Returns:

a sorted set of integers {s,...,n}.

getHighestTokenIndex

public int getHighestTokenIndex()

Description copied from interface: TokenStructure

Returns the index of the last token node.

Specified by:

getHighestTokenIndex in interface TokenStructure

Returns:

the index of the last token node.

hasTokens

public boolean hasTokens()

Description copied from interface: TokenStructure

Returns true if the token structure (sentence) has any token nodes, otherwise false.

Specified by:

hasTokens in interface TokenStructure

Returns:

true if the token structure (sentence) has any token nodes, otherwise false.

getSentenceID

public int getSentenceID()

Description copied from interface: TokenStructure

Returns the sentence ID

Specified by:

getSentenceID in interface TokenStructure

Returns:

the sentence ID

setSentenceID

public void setSentenceID(int sentenceID)

Description copied from interface: TokenStructure

Sets the sentence ID

Specified by:

setSentenceID in interface TokenStructure

Parameters:

sentenceID - a sentence ID

clear

public void clear()
           throws MaltChainedException

Description copied from interface: LabeledStructure

Resets the structure.

Specified by:

clear in interface LabeledStructure

Throws:

MaltChainedException

getSymbolTables

public SymbolTableHandler getSymbolTables()

Description copied from interface: LabeledStructure

Returns the symbol table handler.

Specified by:

getSymbolTables in interface LabeledStructure

Returns:

the symbol table handler.

setSymbolTables

public void setSymbolTables(SymbolTableHandler symbolTables)

Description copied from interface: LabeledStructure

Sets the symbol table handler.

Specified by:

setSymbolTables in interface LabeledStructure

Parameters:

symbolTables - a symbol table handler.

addLabel

public void addLabel(Element element,
                     java.lang.String labelFunction,
                     java.lang.String label)
              throws MaltChainedException

Description copied from interface: LabeledStructure

Adds a label label to the graph element element

Specified by:

addLabel in interface LabeledStructure

Parameters:

element - a graph element element (a node or a edge).

labelFunction - the name of the symbol table.

label - the string value of the label.

Throws:

MaltChainedException

checkOutNewLabelSet

public LabelSet checkOutNewLabelSet()
                             throws MaltChainedException

Description copied from interface: LabeledStructure

Checks out a new label set from the structure.

Specified by:

checkOutNewLabelSet in interface LabeledStructure

Returns:

a new label set.

Throws:

MaltChainedException

checkInLabelSet

public void checkInLabelSet(LabelSet labelSet)
                     throws MaltChainedException

Description copied from interface: LabeledStructure

Checks in a label set.

Specified by:

checkInLabelSet in interface LabeledStructure

Parameters:

labelSet - a label set.

Throws:

MaltChainedException

addSecondaryEdge

public Edge addSecondaryEdge(ComparableNode source,
                             ComparableNode target)
                      throws MaltChainedException

Specified by:

addSecondaryEdge in interface SecEdgeStructure

Throws:

MaltChainedException

removeSecondaryEdge

public void removeSecondaryEdge(ComparableNode source,
                                ComparableNode target)
                         throws MaltChainedException

Specified by:

removeSecondaryEdge in interface SecEdgeStructure

Throws:

MaltChainedException

addDependencyNode

public DependencyNode addDependencyNode()
                                 throws MaltChainedException

Specified by:

addDependencyNode in interface DependencyStructure

Throws:

MaltChainedException

addDependencyNode

public DependencyNode addDependencyNode(int index)
                                 throws MaltChainedException

Specified by:

addDependencyNode in interface DependencyStructure

Throws:

MaltChainedException

getDependencyNode

public DependencyNode getDependencyNode(int index)
                                 throws MaltChainedException

Description copied from interface: DependencyStructure

Returns the dependency node identified by index if it exists, otherwise null.

Specified by:

getDependencyNode in interface DependencyStructure

Parameters:

index - the index of the dependency node

Returns:

the dependency node identified by index if it exists, otherwise null.

Throws:

MaltChainedException

nDependencyNode

public int nDependencyNode()

Specified by:

nDependencyNode in interface DependencyStructure

getHighestDependencyNodeIndex

public int getHighestDependencyNodeIndex()

Specified by:

getHighestDependencyNodeIndex in interface DependencyStructure

addDependencyEdge

public Edge addDependencyEdge(int headIndex,
                              int dependentIndex)
                       throws MaltChainedException

Description copied from interface: DependencyStructure

Adds an edge from the head to the dependent identified by the indices of the dependency nodes.

Specified by:

addDependencyEdge in interface DependencyStructure

Parameters:

headIndex - the index of the head dependency node

dependentIndex - the index of the dependent dependency node

Returns:

the edge that have been added.

Throws:

MaltChainedException

moveDependencyEdge

public Edge moveDependencyEdge(int newHeadIndex,
                               int dependentIndex)
                        throws MaltChainedException

Description copied from interface: DependencyStructure

Replace the head of the dependent with a new head. The labels are not affected.

Specified by:

moveDependencyEdge in interface DependencyStructure

Parameters:

newHeadIndex - the index of the new head dependency node

dependentIndex - the index of the dependent dependency node

Returns:

the edge that have been moved.

Throws:

MaltChainedException

removeDependencyEdge

public void removeDependencyEdge(int headIndex,
                                 int dependentIndex)
                          throws MaltChainedException

Description copied from interface: DependencyStructure

Remove an edge from the head to the dependent identified by the indices of the dependency nodes.

Specified by:

removeDependencyEdge in interface DependencyStructure

Parameters:

headIndex - the index of the head dependency node

dependentIndex - the index of the dependent dependency node

Throws:

MaltChainedException

linkAllTreesToRoot

public void linkAllTreesToRoot()
                        throws MaltChainedException

Description copied from interface: DependencyStructure

Links all subtrees to the root of the dependency structure.

Specified by:

linkAllTreesToRoot in interface DependencyStructure

Throws:

MaltChainedException

nEdges

public int nEdges()

Description copied from interface: DependencyStructure

Returns the number of edges

Specified by:

nEdges in interface DependencyStructure

Returns:

the number of edges

getEdges

public java.util.SortedSet<Edge> getEdges()

Specified by:

getEdges in interface DependencyStructure

getDependencyIndices

public java.util.SortedSet<java.lang.Integer> getDependencyIndices()

Description copied from interface: DependencyStructure

Returns a sorted set of integers {0,s,..n} , where each index i identifies a dependency node. Index 0 should always be the root dependency node and index s is the first terminal node and index n is the last terminal node.

Specified by:

getDependencyIndices in interface DependencyStructure

Returns:

a sorted set of integers

getDependencyRoot

public DependencyNode getDependencyRoot()

Description copied from interface: DependencyStructure

Returns the root of the dependency structure.

Specified by:

getDependencyRoot in interface DependencyStructure

Returns:

the root of the dependency structure.

hasLabeledDependency

public boolean hasLabeledDependency(int index)

Description copied from interface: DependencyStructure

Returns true if the head edge of the dependency node with index is labeled, otherwise false.

Specified by:

hasLabeledDependency in interface DependencyStructure

Parameters:

index - the index of the dependency node

Returns:

true if the head edge of the dependency node with index is labeled, otherwise false.

isConnected

public boolean isConnected()

Description copied from interface: DependencyStructure

Returns true if all nodes in the dependency structure are connected, otherwise false.

Specified by:

isConnected in interface DependencyStructure

Returns:

true if all nodes in the dependency structure are connected, otherwise false.

isProjective

public boolean isProjective()
                     throws MaltChainedException

Description copied from interface: DependencyStructure

Returns true if all edges in the dependency structure are projective, otherwise false.

Specified by:

isProjective in interface DependencyStructure

Returns:

true if all edges in the dependency structure are projective, otherwise false.

Throws:

MaltChainedException

isSingleHeaded

public boolean isSingleHeaded()

Description copied from interface: DependencyStructure

Returns true if all dependency nodes have at most one incoming edge, otherwise false.

Specified by:

isSingleHeaded in interface DependencyStructure

Returns:

true if all dependency nodes have at most one incoming edge, otherwise false.

isTree

public boolean isTree()

Description copied from interface: DependencyStructure

Returns true if the dependency structure are a tree (isConnected() && isSingleHeaded()), otherwise false.

Specified by:

isTree in interface DependencyStructure

Returns:

true if the dependency structure are a tree (isConnected() && isSingleHeaded()), otherwise false.

nNonProjectiveEdges

public int nNonProjectiveEdges()
                        throws MaltChainedException

Description copied from interface: DependencyStructure

Returns the number of non-projective edges in the dependency structure.

Specified by:

nNonProjectiveEdges in interface DependencyStructure

Returns:

the number of non-projective edges in the dependency structure.

Throws:

MaltChainedException

getDefaultRootEdgeLabels

public LabelSet getDefaultRootEdgeLabels()
                                  throws MaltChainedException

Specified by:

getDefaultRootEdgeLabels in interface DependencyStructure

Throws:

MaltChainedException

getDefaultRootEdgeLabelSymbol

public java.lang.String getDefaultRootEdgeLabelSymbol(SymbolTable table)
                                               throws MaltChainedException

Description copied from interface: DependencyStructure

Returns the default edge label of the root as a string value.

Specified by:

getDefaultRootEdgeLabelSymbol in interface DependencyStructure

Parameters:

table - the symbol table that identifies the label type.

Returns:

the default edge label of the root.

Throws:

MaltChainedException

getDefaultRootEdgeLabelCode

public int getDefaultRootEdgeLabelCode(SymbolTable table)
                                throws MaltChainedException

Description copied from interface: DependencyStructure

Returns the default edge label of the root as an integer value.

Specified by:

getDefaultRootEdgeLabelCode in interface DependencyStructure

Parameters:

table - the symbol table that identifies the label type.

Returns:

the default edge label of the root as an integer value.

Throws:

MaltChainedException

setDefaultRootEdgeLabel

public void setDefaultRootEdgeLabel(SymbolTable table,
                                    java.lang.String defaultRootSymbol)
                             throws MaltChainedException

Description copied from interface: DependencyStructure

Sets the default edge label of the root.

Specified by:

setDefaultRootEdgeLabel in interface DependencyStructure

Parameters:

table - the symbol table that identifies the label type.

defaultRootSymbol - the default root edge label

Throws:

MaltChainedException

setDefaultRootEdgeLabels

public void setDefaultRootEdgeLabels(java.lang.String rootLabelOption,
                                     java.util.SortedMap<java.lang.String,SymbolTable> edgeSymbolTables)
                              throws MaltChainedException

Description copied from interface: DependencyStructure

Sets the default edge label of the root according to the default root label option

Specified by:

setDefaultRootEdgeLabels in interface DependencyStructure

Parameters:

rootLabelOption - the default root label option

edgeSymbolTables - a sorted map that maps the symbol table name to the symbol table object.

Throws:

MaltChainedException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object