cox.jmatt.java.MathTools.graphing
Interface Axis

All Superinterfaces:
Renderable
All Known Implementing Classes:
AxisXML, NOAxis

public interface Axis
extends Renderable

This interface represents a graph's axis. The most common types are the X-axis and Y-axis on a Cartesian plane, but the Axis interface makes no such limiting assumption. For the purposes of this package an Axis represents a graphing component against which actual graphs are drawn, measured, or compared. This interface is designed to represent these concepts in the broadest sense and to leave the actual interpretation and usage to the implementation defining it. So, if a graph required a grid to be drawn Axis can be used for that.

Axis extends Renderable, so anything required but not provided can be configured via the setParameter() or setType() methods.


Method Summary
 boolean setScale(java.lang.Object pScale)
          The scale of an axis determines how measurements and comparisons are made.
 boolean setTickMarks(java.lang.Object pMarks)
          Tick marks are small marks placed on an axis at appropriate intervals.
 
Methods inherited from interface cox.jmatt.java.MathTools.graphing.Renderable
render, setParameter, setType, testCondition
 

Method Detail

setScale

boolean setScale(java.lang.Object pScale)
The scale of an axis determines how measurements and comparisons are made. How, or if, that is used depends on the implementation but this method provides the framework for it.

Parameters:
pScale - The Object representing the scale used for this Axis.
Returns:
true if the pScale makes sense and is set, false otherwise.

setTickMarks

boolean setTickMarks(java.lang.Object pMarks)
Tick marks are small marks placed on an axis at appropriate intervals. Use this method to configure them for this Axis.

Parameters:
pMarks - The Object representing the tick-mark configuration to be used for this Axis.
Returns:
true if pMarks makes sense, false otherwise.