org.jscience.ml.om
Class RootElement

java.lang.Object
  extended by org.jscience.ml.om.RootElement

public class RootElement
extends java.lang.Object

The RootElement element is the root element of a schema element. All other schema elements are grouped below RootElement.
The object itself contains no astronomical data but provides XML namespaces, and schema element containers. A schema element container groups multiple schema elements of one and the same type.
E.g.


Foo
More observer stuff goes here


Foo
More observer stuff goes here


In this example is the container element of multiple elements.
Also the RootElement object contains the serializeToSchema() method, that will create a schema valid XML file.

Since:
1.0

Field Summary
static java.lang.String XML_EYEPIECE_CONTAINER
           
static java.lang.String XML_IMAGER_CONTAINER
           
static java.lang.String XML_NS
           
static java.lang.String XML_NS_KEY
           
static java.lang.String XML_OBSERVATION_CONTAINER
           
static java.lang.String XML_OBSERVER_CONTAINER
           
static java.lang.String XML_SCHEMA_LOCATION
           
static java.lang.String XML_SCHEMA_LOCATION_KEY
           
static java.lang.String XML_SCHEMA_VERSION
           
static java.lang.String XML_SCHEMA_VERSION_KEY
           
static java.lang.String XML_SCOPE_CONTAINER
           
static java.lang.String XML_SESSION_CONTAINER
           
static java.lang.String XML_SI
           
static java.lang.String XML_SI_KEY
           
static java.lang.String XML_SITE_CONTAINER
           
static java.lang.String XML_TARGET_CONTAINER
           
 
Constructor Summary
RootElement()
           
 
Method Summary
 void addEyepiece(IEyepiece eyepiece)
           
 void addEyepieces(java.util.Collection eyepieces)
           
 void addImager(IImager imager)
           
 void addImagers(java.util.Collection imagers)
           
 void addObservation(IObservation observation)
           
 void addObservations(java.util.Collection observations)
           
 void addObserver(IObserver observer)
           
 void addObservers(java.util.Collection observers)
           
 void addScope(IScope scope)
           
 void addScopes(java.util.Collection scopes)
           
 void addSession(ISession session)
           
 void addSessions(java.util.Collection sessions)
           
 void addSite(ISite site)
           
 void addSites(java.util.Collection sites)
           
 void addTarget(ITarget target)
           
 void addTargets(java.util.Collection targets)
           
 org.w3c.dom.Document getDocument()
           
 java.util.Collection getEyepieceList()
           
 java.util.Collection getImagerList()
           
 java.util.Collection getObservations()
           
 java.util.Collection getObserverList()
           
 java.util.Collection getScopeList()
           
 java.util.Collection getSessionList()
           
 java.util.Collection getSiteList()
           
 java.util.Collection getTargetList()
           
 void serializeAsXml(java.io.File xmlFile)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

XML_NS_KEY

public static final java.lang.String XML_NS_KEY
See Also:
Constant Field Values

XML_NS

public static final java.lang.String XML_NS
See Also:
Constant Field Values

XML_SI_KEY

public static final java.lang.String XML_SI_KEY
See Also:
Constant Field Values

XML_SI

public static final java.lang.String XML_SI
See Also:
Constant Field Values

XML_SCHEMA_LOCATION_KEY

public static final java.lang.String XML_SCHEMA_LOCATION_KEY
See Also:
Constant Field Values

XML_SCHEMA_LOCATION

public static final java.lang.String XML_SCHEMA_LOCATION
See Also:
Constant Field Values

XML_SCHEMA_VERSION_KEY

public static final java.lang.String XML_SCHEMA_VERSION_KEY
See Also:
Constant Field Values

XML_SCHEMA_VERSION

public static final java.lang.String XML_SCHEMA_VERSION
See Also:
Constant Field Values

XML_OBSERVATION_CONTAINER

public static final java.lang.String XML_OBSERVATION_CONTAINER
See Also:
Constant Field Values

XML_SESSION_CONTAINER

public static final java.lang.String XML_SESSION_CONTAINER
See Also:
Constant Field Values

XML_TARGET_CONTAINER

public static final java.lang.String XML_TARGET_CONTAINER
See Also:
Constant Field Values

XML_OBSERVER_CONTAINER

public static final java.lang.String XML_OBSERVER_CONTAINER
See Also:
Constant Field Values

XML_SITE_CONTAINER

public static final java.lang.String XML_SITE_CONTAINER
See Also:
Constant Field Values

XML_SCOPE_CONTAINER

public static final java.lang.String XML_SCOPE_CONTAINER
See Also:
Constant Field Values

XML_EYEPIECE_CONTAINER

public static final java.lang.String XML_EYEPIECE_CONTAINER
See Also:
Constant Field Values

XML_IMAGER_CONTAINER

public static final java.lang.String XML_IMAGER_CONTAINER
See Also:
Constant Field Values
Constructor Detail

RootElement

public RootElement()
Method Detail

getObservations

public java.util.Collection getObservations()

getEyepieceList

public java.util.Collection getEyepieceList()

getImagerList

public java.util.Collection getImagerList()

getObserverList

public java.util.Collection getObserverList()

getScopeList

public java.util.Collection getScopeList()

getSessionList

public java.util.Collection getSessionList()

getSiteList

public java.util.Collection getSiteList()

getTargetList

public java.util.Collection getTargetList()

addObservation

public void addObservation(IObservation observation)
                    throws SchemaException
Throws:
SchemaException

addObservations

public void addObservations(java.util.Collection observations)
                     throws SchemaException
Throws:
SchemaException

addEyepiece

public void addEyepiece(IEyepiece eyepiece)
                 throws SchemaException
Throws:
SchemaException

addEyepieces

public void addEyepieces(java.util.Collection eyepieces)
                  throws SchemaException
Throws:
SchemaException

addImager

public void addImager(IImager imager)
               throws SchemaException
Throws:
SchemaException

addImagers

public void addImagers(java.util.Collection imagers)
                throws SchemaException
Throws:
SchemaException

addSite

public void addSite(ISite site)
             throws SchemaException
Throws:
SchemaException

addSites

public void addSites(java.util.Collection sites)
              throws SchemaException
Throws:
SchemaException

addScope

public void addScope(IScope scope)
              throws SchemaException
Throws:
SchemaException

addScopes

public void addScopes(java.util.Collection scopes)
               throws SchemaException
Throws:
SchemaException

addSession

public void addSession(ISession session)
                throws SchemaException
Throws:
SchemaException

addSessions

public void addSessions(java.util.Collection sessions)
                 throws SchemaException
Throws:
SchemaException

addObserver

public void addObserver(IObserver observer)
                 throws SchemaException
Throws:
SchemaException

addObservers

public void addObservers(java.util.Collection observers)
                  throws SchemaException
Throws:
SchemaException

addTarget

public void addTarget(ITarget target)
               throws SchemaException
Throws:
SchemaException

addTargets

public void addTargets(java.util.Collection targets)
                throws SchemaException
Throws:
SchemaException

serializeAsXml

public void serializeAsXml(java.io.File xmlFile)
                    throws SchemaException
Throws:
SchemaException

getDocument

public org.w3c.dom.Document getDocument()
                                 throws SchemaException
Throws:
SchemaException