org.qsos.utils
Interface ILibQSOS

All Known Implementing Classes:
LibQSOS

public interface ILibQSOS

This interface should be implemented by LibQSOS. It contains all the methods of the api defined to make editors.

Author:
Arthur Clerfeuille

Method Summary
 void addAuthor(java.lang.String nameString, java.lang.String emailString)
          Allows to add an author to the list of authors.
 java.lang.String Debugaffichage(java.util.List<SimpleMenuEntry> list)
           
 void delAuthor(java.lang.String name)
          Allows to delete an author.
 java.lang.String getAppname()
          Allows to get the application name.
 java.lang.String getAuthors()
          Allows to get the name of all the authors.
 java.lang.String getCommentByName(java.lang.String name)
          Allows to get the comment on an element.
 java.lang.String getDemoUrl()
          Allows to get the demonstration url.
 java.lang.String getDesc()
          Allows to get the description.
 java.lang.String getDescByName(java.lang.String name, int numDesc)
          Allows to get the description number numDesc of the element called name.
 java.lang.String getLanguage()
          Allows to get the language.
 java.lang.String getLicenseDesc()
          Allows to get the license Description.
 java.lang.String getLicenseId()
          Allows to get the license Id.
 java.lang.String getLicenselist()
          Not implemented yet
 java.lang.String getQsosappfamily()
          Allows to get the application family in QSOS.
 java.lang.String getQsosformat()
          Allows to get the QSOS format.
 java.lang.String getQsosspecificformat()
          Allows to get the QSOS specific format.
 java.lang.String getRelease()
          Allows to get the release number.
 java.lang.String getScoreByName(java.lang.String name)
          Allows to get the score of an element.
 ISheet getSheet()
           
 java.util.List<SimpleMenuEntry> getSimpleTree()
           
 java.lang.String getUrl()
          Allows to get the url.
 void load(java.net.URL url)
          Allows to load the java model corresponding to the xml document found at the url.
 void setAppname(java.lang.String appname)
          Allows to set the application name.
 void setCommentByName(java.lang.String name, java.lang.String comment)
          Allows to set a comment to an element given by his name.
 void setDemoUrl(java.lang.String demourl)
          Allows to set the demonstration url.
 void setDesc(java.lang.String desc)
          Allows to set the description.
 void setLanguage(java.lang.String language)
          Allows to set the language.
 void setLicenseDesc(java.lang.String licensedesc)
          Allows to set the license Description.
 void setLicenseId(java.lang.String licenseId)
          Allows to set the license Id.
 void setQsosappfamily(java.lang.String qsosappfamily)
          Allows to set the application family in QSOS.
 void setQsosformat(java.lang.String qsosformat)
          Allows to set the QSOS format.
 void setQsosspecificformat(java.lang.String qsosspecificformat)
          Allows to set the QSOS specific format.
 void setRelease(java.lang.String release)
          Allows to set the release.
 void setScoreByName(java.lang.String name, java.lang.String score)
          Allows to set the score of an element
 void setSheet(ISheet sheet)
           
 void setUrl(java.lang.String url)
          Allows to set the url.
 void write(java.lang.String path)
          Allows to write the xml file at the given path.
 

Method Detail

load

void load(java.net.URL url)
Allows to load the java model corresponding to the xml document found at the url.

Parameters:
url - the URL where the xml document is get.

getDescByName

java.lang.String getDescByName(java.lang.String name,
                               int numDesc)
Allows to get the description number numDesc of the element called name.

Parameters:
name - the name to search.
numDesc - int representing the number of the description to search.
Returns:
a String corresponding to the description asked.

setCommentByName

void setCommentByName(java.lang.String name,
                      java.lang.String comment)
Allows to set a comment to an element given by his name.

Parameters:
name - the name of the element.
comment - the comment to set.

getCommentByName

java.lang.String getCommentByName(java.lang.String name)
Allows to get the comment on an element.

Parameters:
name - the name of the element to get.
Returns:
a String corresponding to the comment of the element asked.

getScoreByName

java.lang.String getScoreByName(java.lang.String name)
Allows to get the score of an element.

Parameters:
name - the name of the element.
Returns:
a String representing the score of the Element.

setScoreByName

void setScoreByName(java.lang.String name,
                    java.lang.String score)
Allows to set the score of an element

Parameters:
name - the name of the element.
score - a String representing the score to set.

getAuthors

java.lang.String getAuthors()
Allows to get the name of all the authors.

Returns:
a String that contains the names of all the authors.

addAuthor

void addAuthor(java.lang.String nameString,
               java.lang.String emailString)
Allows to add an author to the list of authors.

Parameters:
nameString - the name of the author to add.
emailString - the email of the author to add.

delAuthor

void delAuthor(java.lang.String name)
Allows to delete an author.

Parameters:
name - the name of the author to delete.

getAppname

java.lang.String getAppname()
Allows to get the application name.

Returns:
a string corresponding to the application name.

setAppname

void setAppname(java.lang.String appname)
Allows to set the application name.

Parameters:
appname - the application name to set.

getLanguage

java.lang.String getLanguage()
Allows to get the language.

Returns:
a string corresponding to the language.

setLanguage

void setLanguage(java.lang.String language)
Allows to set the language.

Parameters:
language - the language to set.

getRelease

java.lang.String getRelease()
Allows to get the release number.

Returns:
a string corresponding to the release number.

setRelease

void setRelease(java.lang.String release)
Allows to set the release.

Parameters:
release - the release to set.

getLicenselist

java.lang.String getLicenselist()
Not implemented yet


getLicenseId

java.lang.String getLicenseId()
Allows to get the license Id.

Returns:
a string corresponding to the License Id.

setLicenseId

void setLicenseId(java.lang.String licenseId)
Allows to set the license Id.

Parameters:
licenseId - the license Id to set.

getLicenseDesc

java.lang.String getLicenseDesc()
Allows to get the license Description.

Returns:
a string corresponding to the license Description.

setLicenseDesc

void setLicenseDesc(java.lang.String licensedesc)
Allows to set the license Description.

Parameters:
licensedesc - the license Description to set.

getUrl

java.lang.String getUrl()
Allows to get the url.

Returns:
a string corresponding to the url.

setUrl

void setUrl(java.lang.String url)
Allows to set the url.

Parameters:
url - the url to set.

getDesc

java.lang.String getDesc()
Allows to get the description.

Returns:
a string corresponding to the description.

setDesc

void setDesc(java.lang.String desc)
Allows to set the description.

Parameters:
desc - the description to set.

getDemoUrl

java.lang.String getDemoUrl()
Allows to get the demonstration url.

Returns:
a string corresponding to the demonstration url.

setDemoUrl

void setDemoUrl(java.lang.String demourl)
Allows to set the demonstration url.

Parameters:
demourl - the demonstration url to set.

getQsosformat

java.lang.String getQsosformat()
Allows to get the QSOS format.

Returns:
a string corresponding to the QSOS format.

setQsosformat

void setQsosformat(java.lang.String qsosformat)
Allows to set the QSOS format.

Parameters:
qsosformat - the QSOS format to set.

getQsosspecificformat

java.lang.String getQsosspecificformat()
Allows to get the QSOS specific format.

Returns:
a string corresponding to the QSOS specific format.

setQsosspecificformat

void setQsosspecificformat(java.lang.String qsosspecificformat)
Allows to set the QSOS specific format.

Parameters:
qsosspecificformat - the QSOS specific format to set.

getQsosappfamily

java.lang.String getQsosappfamily()
Allows to get the application family in QSOS.

Returns:
a string corresponding to the application family in QSOS.

setQsosappfamily

void setQsosappfamily(java.lang.String qsosappfamily)
Allows to set the application family in QSOS.

Parameters:
qsosappfamily - the application family in QSOS to set.

write

void write(java.lang.String path)
Allows to write the xml file at the given path. This method has a problem since it degrated the xml file ( not the datas but the presentation). It will be fixed in the next version

Parameters:
path -

getSimpleTree

java.util.List<SimpleMenuEntry> getSimpleTree()

Debugaffichage

java.lang.String Debugaffichage(java.util.List<SimpleMenuEntry> list)
Parameters:
list -
Returns:

getSheet

ISheet getSheet()

setSheet

void setSheet(ISheet sheet)
Parameters:
sheet -