net.aerith.misao.xml
Class XmlInstruction

java.lang.Object
  |
  +--net.aerith.misao.xml.IONode
        |
        +--net.aerith.misao.xml.relaxer.XmlInstruction
              |
              +--net.aerith.misao.xml.XmlInstruction

public class XmlInstruction

extends XmlInstruction

The XmlInstruction is an application side implementation of the class that the relaxer generated automatically.

See Also:

Serialized Form

Fields inherited from class net.aerith.misao.xml.relaxer.XmlInstruction

baseCatalog, center, chip, date, exposure, filter, fov, image, instruments, limitingMag, observer, output, parentRNode, rContext, reversedImage, rotation, sbigImage, unofficial, upperLimitMag

Constructor Summary

XmlInstruction()

Method Summary

boolean	fixesLimitingMagnitude() Returns true when not to calculate the limiting magnitude automatically.
java.io.File	getImageFile(FileManager file_manager) Gets the image file.
java.lang.String	getOutput(java.lang.String type) Gets the output file name of the specified type.
double	getProperLimitingMag() Gets the proper limiting magnitude.
double	getProperUpperLimitMag() Gets the proper upper-limit magnitude.

Methods inherited from class net.aerith.misao.xml.relaxer.XmlInstruction

addOutput, getBaseCatalog, getCenter, getChip, getDate, getExposure, getFilter, getFov, getImage, getInstruments, getLimitingMag, getObserver, getOutput, getParentRNode, getRContext, getRContextResolved, getReversedImage, getRNodes, getRotation, getSbigImage, getUnofficial, getUpperLimitMag, init, isMatch, isMatch, isMatchHungry, makeElement, setBaseCatalog, setCenter, setChip, setDate, setExposure, setFilter, setFov, setImage, setInstruments, setLimitingMag, setObserver, setOutput, setParentRNode, setRContext, setReversedImage, setRotation, setSbigImage, setUnofficial, setup, setup, setup, setUpperLimitMag

Methods inherited from class net.aerith.misao.xml.IONode

read, read, translateFrom, translateTo, write, write

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait

Constructor Detail

XmlInstruction

public XmlInstruction()

Method Detail

getOutput

public java.lang.String getOutput(java.lang.String type)

Gets the output file name of the specified type.

Parameters:

type - the type of the file.

Returns:

the output file name of the specified type, or null if no file name of the type is recorded in the XML document.

getImageFile

public java.io.File getImageFile(FileManager file_manager)

Gets the image file. In general, it returns a file at the specified relative path of the specified file manager. If it does not exist, it returns a file at the specified relative path from the directory where the XML report document is stored. In the latter case, the XML file path must be recorded in the

element with a type attribute of "xml".

Parameters:

file_manager - the file manager.

Returns:

the image file.

fixesLimitingMagnitude

public boolean fixesLimitingMagnitude()

Returns true when not to calculate the limiting magnitude automatically.

Returns:

true when not to calculate the limiting magnitude automatically.

getProperLimitingMag

public double getProperLimitingMag()

Gets the proper limiting magnitude. In the case the limiting magnitude is not recorded, it returns the upper-limit magnitude.

Returns:

the proper limiting magnitude.

getProperUpperLimitMag

public double getProperUpperLimitMag()

Gets the proper upper-limit magnitude. In the case the upper-limit magnitude is not recorded, it returns the limiting magnitude.

Returns:

the proper upper-limit magnitude.