|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The IGraphicDocumentGenerator
interface provides users with access
to objects which generate graphic visualizations of (potentially) dynamic input data.
These objects encapsulate the state data needed for generating the various
visualizations supported by the implementation.
Method Summary | |
boolean |
addGraphicColourPalette(java.lang.String paletteName,
java.lang.String[] palette)
Adds the specified colour palette to the set of colour palettes which are available for the graphic generated by this object. |
java.lang.String |
generateAndSerialize()
Generates a graphic Document object based on the input data and
returns it XML-serialized to a String . |
boolean |
generateAndSerializeTo(java.lang.String filename)
Generates a graphic Document object by based on the input data and then
XML-serializes it to the specified filename on the local machine where this object
is executing. |
org.w3c.dom.Document |
generateGraphicDocument()
Generates and returns a graphic Document object based on input data |
org.w3c.dom.Document |
getConfigDocument()
Returns the Document object which provides the configuration data
for the graphic generated by this object or null if none has been
set. |
org.w3c.dom.Document |
getDataDocument()
Returns the Document object which provides the content data
for the graphic generated by this object or null if none has been
set. |
org.w3c.dom.Document |
getGeneratedDocument()
Returns the Document object generated by this object or null
if none has been generated. |
java.lang.String[] |
getGraphicColourPalette()
Returns the set of colours belonging to the default colour palette used by the graphic generated by this object. |
java.lang.String |
getGraphicColourPaletteName()
Returns the name of the default colour palette used by the graphic generated by this object. |
java.lang.String |
getGraphicFont()
Returns the font used by the graphic generated by this object. |
java.lang.String |
getGraphicHeight()
Returns the height of the graphic generated by this object. |
java.lang.String |
getGraphicLegendTitle()
Returns the legend title of the graphic generated by this object or null
if the graphic does not support a legend or no title has been specified. |
java.lang.String |
getGraphicTimestampPrefix()
Returns the timestamp prefix of the graphic generated by this object or null if none has been specified. |
java.lang.String |
getGraphicTitle()
Returns the title of the graphic generated by this object or null
if none has been specified. |
java.lang.String |
getGraphicType()
Returns the type indicator for the graphic generated by this object. |
java.lang.String |
getGraphicWidth()
Returns the width of the graphic generated by this object. |
java.lang.String |
getPreferencesPage()
Returns the user preferences page name associated with the generated graphic or null if none has been specified. |
java.lang.String |
getPreferencesPageHeight()
Returns the height of the window which displays the user preferences page associated with the generated graphic. |
java.lang.String |
getPreferencesPageWidth()
Returns the width of the window which displays the user preferences page associated with the generated graphic. |
java.lang.String |
getResourcesFolder()
Returns the folder location for any resources needed by the generated graphic or null if none has been specified . |
boolean |
isLegendSuppressed()
Returns the legend suppression indicator for the graphic generated by this object. |
boolean |
serializeGeneratedDocumentToFile(java.lang.String filename)
XML-serializes the generated Document object to the specified location
on the physical machine where this object is executing. |
byte[] |
serializeGeneratedDocumentToStream()
XML-serializes and returns the generated Document object as a byte array. |
java.lang.String |
serializeGeneratedDocumentToString()
XML-serializes and returns the generated Document object as a String . |
void |
setConfigDocument(org.w3c.dom.Document newConfigDocument)
Specifies the XML document which is to provide the configuration data for the graphic generated by this object. |
void |
setDataDocument(org.w3c.dom.Document newDataDocument)
Specifies the XML document which is to provide the content data for the graphic generated by this object. |
boolean |
setGraphicColourPaletteName(java.lang.String newGraphicColourPaletteName)
Specifies the name of the default colour palette to be used by the graphic generated by this object. |
void |
setGraphicFont(java.lang.String newGraphicFont)
Specifies the font to be used by the graphic generated by this object. |
void |
setGraphicHeight(java.lang.String newGraphicHeight)
Specifies the height of the graphic generated by this object. |
void |
setGraphicLegendTitle(java.lang.String newGraphicLegendTitle)
Specifies the legend title of the graphic generated by this object. |
void |
setGraphicTimestampPrefix(java.lang.String newGraphicTimestampPrefix)
Specifies the prefix for the timestamp of the graphic generated by this object. |
void |
setGraphicTitle(java.lang.String newGraphicTitle)
Specifies the title of the graphic generated by this object. |
void |
setGraphicWidth(java.lang.String newGraphicWidth)
Specifies the width of the graphic generated by this object. |
void |
setPreferencesPage(java.lang.String newPreferencesPage)
Specifies the user preferences page to be used. |
void |
setPreferencesPageHeight(java.lang.String newPreferencesPageHeight)
Specifies the height for the window which displays the user preferences page. |
void |
setPreferencesPageWidth(java.lang.String newPreferencesPageWidth)
Specifies the width for the window which displays the user preferences page. |
void |
setResourcesFolder(java.lang.String newResourcesFolder)
Specifies the folder URL on the local machine where this object is executing in which any resources needing to be accessed by the generated graphic are located. |
void |
setSuppressLegend(java.lang.String newSuppressLegend)
Specifies whether the legend should be suppressed in the graphic generated by this object. |
Method Detail |
public java.lang.String getGraphicType()
public org.w3c.dom.Document getGeneratedDocument()
Document
object generated by this object or null
if none has been generated.
org.w3c.dom.Document
public org.w3c.dom.Document getConfigDocument()
Document
object which provides the configuration data
for the graphic generated by this object or null
if none has been
set.
org.w3c.dom.Document
and conforms to the configuration schema for the generator.public org.w3c.dom.Document getDataDocument()
Document
object which provides the content data
for the graphic generated by this object or null
if none has been
set.
org.w3c.dom.Document
and conforms to the data schema for the generator.public java.lang.String getGraphicHeight()
public java.lang.String getGraphicWidth()
public java.lang.String getGraphicFont()
public java.lang.String getGraphicColourPaletteName()
IGraphicDocumentStyle
public java.lang.String[] getGraphicColourPalette()
String
array of hexadecimal coloursIGraphicDocumentStyle
public java.lang.String getGraphicTitle()
null
if none has been specified.
public java.lang.String getGraphicTimestampPrefix()
null
if none has been specified.
public boolean isLegendSuppressed()
false
, if legend is to be displayed or is not supported by the graphic type.public java.lang.String getGraphicLegendTitle()
null
if the graphic does not support a legend or no title has been specified.
public java.lang.String getResourcesFolder()
null
if none has been specified .
public java.lang.String getPreferencesPage()
null
if none has been specified.
public java.lang.String getPreferencesPageWidth()
public java.lang.String getPreferencesPageHeight()
public void setConfigDocument(org.w3c.dom.Document newConfigDocument) throws DataInputProcessingException
newConfigDocument
- an object, which implements org.w3c.dom.Document
and conforms to the configuration schema for the generator.
DataInputProcessingException
public void setDataDocument(org.w3c.dom.Document newDataDocument) throws DataInputProcessingException
newDataDocument
- an object, which implements org.w3c.dom.Document
and conforms to the content data schema for the generator.
DataInputProcessingException
public void setGraphicHeight(java.lang.String newGraphicHeight)
int
zero will be substituted. Extending
classes should override this behaviour and provide a default value in this
case. Note that since this information is generated into the graphic, this method
must be called before generating the graphic.
newGraphicHeight
- the pixel height of the generated graphicpublic void setGraphicWidth(java.lang.String newGraphicWidth)
int
zero will be substituted. Extending
classes should override this behaviour and provide a default value in this
case. Note that since this information is generated into the graphic, this method
must be called before generating the graphic.
newGraphicWidth
- the pixel width of the generated graphicpublic void setGraphicFont(java.lang.String newGraphicFont)
newGraphicFont
- the font family namepublic boolean setGraphicColourPaletteName(java.lang.String newGraphicColourPaletteName)
newGraphicColourPaletteName
- one of the documented or user-supplied names
true
, if the supplied name is recognizedpublic void setGraphicTitle(java.lang.String newGraphicTitle)
newGraphicTitle
- the title, which will be trimmed.public void setGraphicTimestampPrefix(java.lang.String newGraphicTimestampPrefix)
newGraphicTimestampPrefix
- the prefix, which will be trimmed and prepended to the timestamp.public void setSuppressLegend(java.lang.String newSuppressLegend)
false
will be substituted. Note that since this information
is generated into the graphic, this method must be called before generating the graphic.
newSuppressLegend
- must be one of {"true", "false", "1", "0"}.public void setGraphicLegendTitle(java.lang.String newGraphicLegendTitle)
newGraphicLegendTitle
- the title, which will be trimmed and displayed over the legendpublic void setResourcesFolder(java.lang.String newResourcesFolder)
newResourcesFolder
- the folder URL location of the resources, which will be trimmed.public void setPreferencesPage(java.lang.String newPreferencesPage)
newPreferencesPage
- the folder location of the page which is to replace the
existing preferences page. This value will be trimmed.public void setPreferencesPageWidth(java.lang.String newPreferencesPageWidth)
newPreferencesPageWidth
- the pixel widthpublic void setPreferencesPageHeight(java.lang.String newPreferencesPageHeight)
newPreferencesPageHeight
- the pixel heightspublic boolean addGraphicColourPalette(java.lang.String paletteName, java.lang.String[] palette) throws java.lang.NullPointerException
paletteName
- the name of the palettepalette
- the colours (hexadecimal codes)
true
, if the operation is successful
java.lang.NullPointerException
public org.w3c.dom.Document generateGraphicDocument() throws DataInputProcessingException
Document
object based on input data
DataInputProcessingException
public java.lang.String generateAndSerialize() throws DataInputProcessingException, java.io.IOException
Document
object based on the input data and
returns it XML-serialized to a String
.
DataInputProcessingException
java.io.IOException
public boolean generateAndSerializeTo(java.lang.String filename) throws DataInputProcessingException, java.io.IOException
Document
object by based on the input data and then
XML-serializes it to the specified filename on the local machine where this object
is executing.
filename
- the location to where the generated object is to be XML-serialized.
true
, if the operation is successful
DataInputProcessingException
java.io.IOException
public boolean serializeGeneratedDocumentToFile(java.lang.String filename) throws java.io.IOException
Document
object to the specified location
on the physical machine where this object is executing.
filename
- The location to which the object is serialized.
true
, if the operation is successful.
java.io.IOException
public java.lang.String serializeGeneratedDocumentToString() throws java.io.IOException
Document
object as a String
.
Document
java.io.IOException
public byte[] serializeGeneratedDocumentToStream()
Document
object as a byte array.
Document
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |