|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.hackystat.tickertape.tickerlingua.TickerLingua
public class TickerLingua
Reads a TickerLingua definition file, validates it, and provides access to its components.
A valid TickerLingua definition file is both syntactically and semantically valid.
Syntactic validity means that it satisfies the XmlSchema definition for a TickerLingua file. See the tickerlingua.definition.xsd file for details on syntactic validity. This is assessed by the JAXB parser when the file is read in.
Semantic validity involves ensuring the following:
In addition, if a HackystatProject refers to a sensorbase that cannot be contacted, or a user/password combination that is not legal, then a warning message is logged.
If a tickerlingua.xml definition file cannot be found, or is not both syntactically and semantically valid, then a RuntimeException is thrown.
Constructor Summary | |
---|---|
TickerLingua()
Creates a TickerLingua instance from default location ~/.hackystat/tickertape/tickertape.xml. |
|
TickerLingua(java.lang.String filePath)
Creates a TickerLingua instance from the passed file. |
Method Summary | |
---|---|
java.lang.String |
findFullName(java.lang.String email)
Returns the full name associated with the email, or null if not found. |
java.util.Collection<HackystatUser> |
getHackystatUsers()
Returns the set of defined HackystatUsers. |
java.lang.String |
getLoggingLevel()
Returns the logging level specified in the globals section, or "INFO" if none specified. |
(package private) java.util.Map<java.lang.String,HackystatProject> |
getProjects()
Return the services. |
(package private) java.util.Map<java.lang.String,HackystatService> |
getServices()
Return the services. |
java.lang.String |
getSmtpServer()
Returns the smtp server specified in the Globals section, or null if none specified. |
Tickertape |
getTickertape(java.lang.String id)
Return the Tickertape instance with the specified ID, or null if not found. |
java.util.List<Tickertape> |
getTickertapes()
Return a list of all Tickertape instances. |
(package private) java.util.Map<java.lang.String,HackystatUser> |
getUsers()
Return the services. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TickerLingua() throws TickerLinguaException
TickerLinguaException
- If problems occur while getting or processing the file.public TickerLingua(java.lang.String filePath) throws TickerLinguaException
filePath
- A path to the file.
TickerLinguaException
- If problems occur while getting or processing the file.Method Detail |
---|
public java.lang.String getSmtpServer()
public java.lang.String getLoggingLevel()
java.util.Map<java.lang.String,HackystatService> getServices()
java.util.Map<java.lang.String,HackystatUser> getUsers()
java.util.Map<java.lang.String,HackystatProject> getProjects()
public Tickertape getTickertape(java.lang.String id)
id
- The id.
public java.util.List<Tickertape> getTickertapes()
public java.util.Collection<HackystatUser> getHackystatUsers()
public java.lang.String findFullName(java.lang.String email)
email
- The email.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |