org.jscience.ml.om
Interface ISchemaElement

All Known Subinterfaces:
IEyepiece, IFinding, IImager, IObservation, IObserver, IScope, ISession, ISite, ITarget
All Known Implementing Classes:
CCDImager, DeepSkyFinding, DeepSkyTarget, DeepSkyTargetDN, DeepSkyTargetDS, DeepSkyTargetGC, DeepSkyTargetGN, DeepSkyTargetGX, DeepSkyTargetNA, DeepSkyTargetOC, DeepSkyTargetPN, DeepSkyTargetQS, EquPosition, Eyepiece, Finding, GenericFinding, Imager, Observation, Observer, SchemaElement, Scope, Session, Site, SolarSystemTarget, SolarSystemTargetComet, SolarSystemTargetMinorPlanet, SolarSystemTargetMoon, SolarSystemTargetPlanet, SolarSystemTargetSun, Target

public interface ISchemaElement

The ISchemaElement is the root interface for almost all astro XML schema elements. It contains only element informations that are common for all (or almost all) elements.

Since:
1.0

Field Summary
static java.lang.String XML_ELEMENT_ATTRIBUTE_ID
          Constant for XML representation: ID attribute
Almost all astro XML schema elements contain the ID attribute which is used for linking the different elements logical together.
 
Method Summary
 java.lang.String getDisplayName()
          Returns a display name for this element.
 java.lang.String getID()
          Returns a unique ID of this schema element.
 

Field Detail

XML_ELEMENT_ATTRIBUTE_ID

static final java.lang.String XML_ELEMENT_ATTRIBUTE_ID
Constant for XML representation: ID attribute
Almost all astro XML schema elements contain the ID attribute which is used for linking the different elements logical together.
Example:
<AnAstroXmlElement id="someID">
More stuff goes here
</AnAstroXmlElement>

<AnotherAstroXmlElement id="someOtherID">
More stuff goes here
<AnAstroXmlElement>someID;</AnAstroXmlElement>

More stuff goes here </AnotherAstroXmlElement>

See Also:
Constant Field Values
Method Detail

getID

java.lang.String getID()
Returns a unique ID of this schema element.
The ID is used to link this element with other XML elements in the schema.

Returns:
Returns a String representing a unique ID of this schema element.

getDisplayName

java.lang.String getDisplayName()
Returns a display name for this element.
The method differs from the toString() method as toString() shows more technical information about the element. Also the formating of toString() can spread over several lines.
This method returns a string (in one line) that can be used as displayname in e.g. a UI dropdown box.

Returns:
Returns a String with a one line display name
See Also:
java.lang.Object.toString();