salsa.corpora.elements
Class FrameElement

java.lang.Object
  extended by salsa.corpora.elements.FrameElement

public class FrameElement
extends java.lang.Object

Represents a frame element 'fe' in a SalsaXML corpus.

Author:
Fabian Shirokov

Constructor Summary
FrameElement(Id id, java.lang.String name)
          Default constructor that takes the Id and the name of the FrameElement as arguments.
FrameElement(Id id, java.lang.String name, java.lang.String usp)
          Constructor that takes the Id, the name and the 'usp' value of the FrameElement as arguments.
 
Method Summary
 void addFenode(Fenode newFenode)
          Adds a new Fenode to this FrameElement.
 void addFlag(Flag newFlag)
          Adds a new Flag to this FrameElement.
 java.util.ArrayList<Fenode> getFenodes()
          Returns the list of Fenode elements of this FrameElement.
 java.util.ArrayList<Flag> getFlags()
          Returns the list of Flag elements of this FrameElement.
 Id getId()
          Returns the Id of this FrameElement.
 java.lang.String getName()
          Returns the name of this FrameElement, e. g.
 java.lang.String getSource()
          Returns the source of this FrameElement.
 java.lang.String getUsp()
          Returns the 'usp' value of this FrameElement, e. g.
static java.lang.String getXmltag()
          Returns the name of the XML element of FrameElement, i.
 void setId(Id id)
          Sets the Id of this FrameElement.
 void setName(java.lang.String name)
          Sets the name of this FrameElement.
 void setSource(java.lang.String source)
          Sets the source of this FrameElement.
 void setUsp(java.lang.String usp)
          Sets the 'usp' value of this FrameElement.
 java.lang.String toString()
          Returns a recursively created XML representation of FrameElement.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FrameElement

public FrameElement(Id id,
                    java.lang.String name)
Default constructor that takes the Id and the name of the FrameElement as arguments.

Parameters:
id -
name -

FrameElement

public FrameElement(Id id,
                    java.lang.String name,
                    java.lang.String usp)
Constructor that takes the Id, the name and the 'usp' value of the FrameElement as arguments.

Parameters:
id -
name -
usp -
Method Detail

addFenode

public void addFenode(Fenode newFenode)
Adds a new Fenode to this FrameElement.


addFlag

public void addFlag(Flag newFlag)
Adds a new Flag to this FrameElement.


getFenodes

public java.util.ArrayList<Fenode> getFenodes()
Returns the list of Fenode elements of this FrameElement.

Returns:
the fenodes

getFlags

public java.util.ArrayList<Flag> getFlags()
Returns the list of Flag elements of this FrameElement.

Returns:
the flags

getId

public Id getId()
Returns the Id of this FrameElement.

Returns:
the id

getName

public java.lang.String getName()
Returns the name of this FrameElement, e. g. 'Agent'.

Returns:
the name

getSource

public java.lang.String getSource()
Returns the source of this FrameElement.

Returns:
the source

getUsp

public java.lang.String getUsp()
Returns the 'usp' value of this FrameElement, e. g. 'yes'.

Returns:
the usp

getXmltag

public static java.lang.String getXmltag()
Returns the name of the XML element of FrameElement, i. e. 'fe'.

Returns:
the xmltag

setId

public void setId(Id id)
Sets the Id of this FrameElement.

Parameters:
id - the id to set

setName

public void setName(java.lang.String name)
Sets the name of this FrameElement.

Parameters:
name - the name to set

setSource

public void setSource(java.lang.String source)
Sets the source of this FrameElement.

Parameters:
source - the source to set

setUsp

public void setUsp(java.lang.String usp)
Sets the 'usp' value of this FrameElement.

Parameters:
usp - the usp to set

toString

public java.lang.String toString()
Returns a recursively created XML representation of FrameElement.

Overrides:
toString in class java.lang.Object