it.uniroma2.sag.kelp.data.representation.structure

Class StructureElement

java.lang.Object

it.uniroma2.sag.kelp.data.representation.structure.StructureElement

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CompositionalStructureElement, LexicalStructureElement, PosStructureElement, SyntacticStructureElement, UntypedStructureElement

public abstract class StructureElement
extends Object
implements Serializable

This class represent the atomic element of a discrete structure. It has been designed to represent the "content" of each basic element of a structure.

Author:

Simone Filice, Danilo Croce

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected HashMap<String,Object>	additionalInformation

Constructor Summary

Constructors

Constructor and Description
StructureElement()

Method Summary

Methods

Modifier and Type	Method and Description
void	addAdditionalInformation(String infoName, Object infoContent) Adds an additional information identified by infoName
boolean	containsAdditionalInfo(String infoName) Verifies whether this element contains the additional information identified by infoName
Object	getAdditionalInformation(String infoName) Returns the additional information identified by infoName
abstract String	getTextFromData() Returns a textual representation of the data stored in this structureElement
String	getTextFromDataWithAdditionalInfo() Returns the textual format of the content, concatenated with all the additional information added to this element
Object	removeAdditionalInformation(String infoName)
abstract void	setDataFromText(String structureElementDescription) Initializes a StructureElement using its textual description provided in structureElementDescription

Methods inherited from class java.lang.Object

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

Field Detail

additionalInformation

protected HashMap<String,Object> additionalInformation

Constructor Detail

StructureElement

public StructureElement()

Method Detail

setDataFromText

public abstract void setDataFromText(String structureElementDescription)
                              throws Exception

Initializes a StructureElement using its textual description provided in structureElementDescription

Parameters:

structureElementDescription - the textual description of the structureElement to be initialized

Throws:

Exception

getTextFromData

public abstract String getTextFromData()

Returns a textual representation of the data stored in this structureElement

Returns:

a textual representation of the data stored in this structureElement

addAdditionalInformation

public void addAdditionalInformation(String infoName,
                            Object infoContent)

Adds an additional information identified by infoName

Parameters:

infoName - the identifier of the additional information

infoContent - the additional information

getAdditionalInformation

public Object getAdditionalInformation(String infoName)

Returns the additional information identified by infoName

Parameters:

infoName - the identifier of the additional information

Returns:

the additional information identified by infoName; null if that information is not contained

containsAdditionalInfo

public boolean containsAdditionalInfo(String infoName)

Verifies whether this element contains the additional information identified by infoName

Parameters:

infoName - the identifier of the additional information

Returns:

true if this element contains the additional information identified by infoName; false otherwise

removeAdditionalInformation

public Object removeAdditionalInformation(String infoName)

getTextFromDataWithAdditionalInfo

public String getTextFromDataWithAdditionalInfo()

Returns the textual format of the content, concatenated with all the additional information added to this element

Returns:

the textual format of the content, concatenated with all the additional information added to this element