salsa.corpora.elements
Class Frame

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

public class Frame
extends java.lang.Object

Represents a 'frame' section in a SalsaXML corpus.

Author:
Fabian Shirokov

Constructor Summary
Frame(java.lang.String name)
          This constructor is used for frames in the 'head' section.
Frame(java.lang.String name, Id id)
          This constructor is used for frames in the 'body' section.
 
Method Summary
 void addElement(Element newElement)
          Adds a Element to this Frame.
 void addFe(FrameElement newFe)
          Adds a new FrameElement to this Frame.
 void addFlag(Flag newFlag)
          Adds a new Flag to this Frame.
 java.util.ArrayList<Element> getElements()
          Returns the list of the Element elements of this Frame.
 java.util.ArrayList<FrameElement> getFes()
          Returns the list of the FrameElement elements of this Frame.
 java.util.ArrayList<Flag> getFlags()
          Returns the list of the Flag elements of this Frame.
 Id getId()
          Returns the Id.
 java.lang.String getName()
          Returns the name of the this Frame, e. g.
 java.lang.String getSource()
          Returns the value of the 'source' attribute, e. g. '1'.
 Target getTarget()
          Returns the Target of this Frame.
 java.lang.String getUsp()
          Returns the value of the 'usp' attribute.
static java.lang.String getXmltag()
          Returns the name of the XML element of Frame, i. e.
 void setId(Id id)
          Sets the Id.
 void setName(java.lang.String name)
          Sets the name of this frame.
 void setSource(java.lang.String source)
          Sets the value of the 'source' attribute.
 void setTarget(Target target)
          Sets the Target.
 void setUsp(java.lang.String usp)
          Sets the value of the 'usp' attribute.
 java.lang.String toString()
          Returns a recursively created XML representation of this Frame.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Frame

public Frame(java.lang.String name)
This constructor is used for frames in the 'head' section. It takes the name of the frame as an argument.

Parameters:
name -

Frame

public Frame(java.lang.String name,
             Id id)
This constructor is used for frames in the 'body' section. It takes the name of the frame and the Id as an argument.

Parameters:
name -
Method Detail

addElement

public void addElement(Element newElement)
Adds a Element to this Frame.


addFe

public void addFe(FrameElement newFe)
Adds a new FrameElement to this Frame.


addFlag

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


getElements

public java.util.ArrayList<Element> getElements()
Returns the list of the Element elements of this Frame.

Returns:
the elements

getFes

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

Returns:
the fes

getFlags

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

Returns:
the flags

getId

public Id getId()
Returns the Id.

Returns:
the id

getName

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

Returns:
the name

getSource

public java.lang.String getSource()
Returns the value of the 'source' attribute, e. g. '1'.

Returns:
the source

getTarget

public Target getTarget()
Returns the Target of this Frame.

Returns:
the target

getUsp

public java.lang.String getUsp()
Returns the value of the 'usp' attribute.

Returns:

getXmltag

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

Returns:
the xmltag

setId

public void setId(Id id)
Sets the Id.

Parameters:
id - the id to set

setName

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

Parameters:
name - the name to set

setSource

public void setSource(java.lang.String source)
Sets the value of the 'source' attribute.

Parameters:
source - the source to set

setTarget

public void setTarget(Target target)
Sets the Target.

Parameters:
target - the target to set

setUsp

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

Parameters:
usp -

toString

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

Overrides:
toString in class java.lang.Object