org.qsos.data
Interface IElement

All Known Implementing Classes:
Element

public interface IElement

This interface should be implemented by an Element

Author:
Romain Pelisse , Arthur Clerfeuille

Method Summary
 IElement addElement(IElement item)
          Allow to add item to the list of sub element
 void delElement(IElement author)
           
 java.lang.String getComment()
           
 IElement getContainer()
          Return an IElement which represents the parent of the current Element.
 java.lang.String getDesc()
           
 java.lang.String getDesc0()
           
 java.lang.String getDesc1()
           
 java.lang.String getDesc2()
           
 java.util.List<IElement> getElements()
          Return a List of IElement which represents all the children of the current Element.
 java.lang.Long getId()
          Returns the id of the Element.
 java.lang.String getMeta()
          Return the meta in the Element.
 java.lang.String getName()
          Return the name in the Element.
 java.lang.String getScore()
           
 java.lang.String getText()
          Return the text in the Element.
 java.lang.String getTitle()
          Return the name in the Element.
 void setComment(java.lang.String text)
           
 void setContainer(IElement element)
          Allow to set the container (the parent of an Element).
 void setDesc(java.lang.String desc)
           
 void setDesc0(java.lang.String text)
           
 void setDesc1(java.lang.String text)
           
 void setDesc2(java.lang.String text)
           
 void setElements(java.util.List<IElement> elements)
          Allow to set the children of the current Element.
 void setId(java.lang.Long id)
          Allows to set the id of the Element.
 void setMeta(java.lang.String meta)
          Allows to set the meta of the Element.
 void setName(java.lang.String name)
          Allows to set the name of the Element.
 void setScore(java.lang.String text)
           
 void setText(java.lang.String text)
          Allows to set the text of the Element.
 void setTitle(java.lang.String title)
          Allows to set the title of the Element.
 java.lang.String toString()
           Returns a string representation of the Element
 java.lang.String tree()
          Return a string version of the Element and its childs.
 

Method Detail

getId

java.lang.Long getId()

Returns the id of the Element.

Returns:
Returns a Long which is the id.

setId

void setId(java.lang.Long id)

Allows to set the id of the Element.

Parameters:
id - The id to set.

getMeta

java.lang.String getMeta()
Return the meta in the Element.

Returns:
Returns a String which is the meta.

setMeta

void setMeta(java.lang.String meta)

Allows to set the meta of the Element.

Parameters:
meta - the meta to set.

getName

java.lang.String getName()
Return the name in the Element.

Returns:
Returns a String which is the name.

setName

void setName(java.lang.String name)

Allows to set the name of the Element.

Parameters:
name - the name to set.

getTitle

java.lang.String getTitle()
Return the name in the Element.

Returns:
Returns a String which is the name.

setTitle

void setTitle(java.lang.String title)

Allows to set the title of the Element.

Parameters:
title - the title to set.

getText

java.lang.String getText()
Return the text in the Element.

Returns:
Returns a String which is the text.

setText

void setText(java.lang.String text)

Allows to set the text of the Element.

Parameters:
text - the text to set.

getElements

java.util.List<IElement> getElements()

Return a List of IElement which represents all the children of the current Element.

Returns:
Returns the list of the sub elements.

setElements

void setElements(java.util.List<IElement> elements)

Allow to set the children of the current Element.

Parameters:
elements - The List of Elements to set.

getContainer

IElement getContainer()

Return an IElement which represents the parent of the current Element.

Returns:
IElement the container.

setContainer

void setContainer(IElement element)

Allow to set the container (the parent of an Element).

Parameters:
element - the IElement to set as container of the current Element.

addElement

IElement addElement(IElement item)

Allow to add item to the list of sub element

Parameters:
item - the IElement to add to the children of this object.
Returns:
the added element.

toString

java.lang.String toString()

Returns a string representation of the Element

Overrides:
toString in class java.lang.Object
Returns:
Returns a string representation of the Element.

tree

java.lang.String tree()

Return a string version of the Element and its childs. This method is designed to ease unit test and debug and is not to be used for anything else.

Returns:
string version of the Element.

setDesc

void setDesc(java.lang.String desc)

getDesc

java.lang.String getDesc()

setDesc0

void setDesc0(java.lang.String text)
Parameters:
text -

getDesc0

java.lang.String getDesc0()
Parameters:
text -

setDesc1

void setDesc1(java.lang.String text)

getDesc1

java.lang.String getDesc1()

setDesc2

void setDesc2(java.lang.String text)
Parameters:
text -

getDesc2

java.lang.String getDesc2()

setComment

void setComment(java.lang.String text)
Parameters:
text -

getComment

java.lang.String getComment()

setScore

void setScore(java.lang.String text)
              throws java.io.IOException
Parameters:
text -
Throws:
java.io.IOException

getScore

java.lang.String getScore()

delElement

void delElement(IElement author)
Parameters:
author -