net.sourceforge.plantuml

Class AbstractPSystem

java.lang.Object

net.sourceforge.plantuml.AbstractPSystem

All Implemented Interfaces:

Diagram

Direct Known Subclasses:

GanttDiagram, NewpagedDiagram, PSystemAppleTwo, PSystemCharlie, PSystemColors, PSystemCreole, PSystemCute, PSystemDedication, PSystemDefinition, PSystemDitaa, PSystemDonors, PSystemDot, PSystemEgg, PSystemError, PSystemJcckit, PSystemLatex, PSystemLicense, PSystemListFonts, PSystemListInternalSprites, PSystemListOpenIconic, PSystemLogo, PSystemLost, PSystemMath, PSystemOpenIconic, PSystemOregon, PSystemPath, PSystemProject, PSystemProject2, PSystemRIP, PSystemSalt, PSystemStats, PSystemSudoku, PSystemTree, PSystemVersion, PSystemWelcome, PSystemXearth, UmlDiagram

public abstract class AbstractPSystem
extends Object
implements Diagram

Constructor Summary

Constructors

Constructor and Description
AbstractPSystem()

Method Summary

Modifier and Type	Method and Description
String	checkFinalError()
CommandExecutionResult	executeCommand(Command cmd, BlocLines lines)
ImageData	exportDiagram(OutputStream os, int index, FileFormatOption fileFormatOption) Export the diagram as an image to some format.
protected abstract ImageData	exportDiagramNow(OutputStream os, int index, FileFormatOption fileFormatOption, long seed)
String	getMetadata()
int	getNbImages() Number of images in this diagram (usually, 1)
UmlSource	getSource() The original source of the diagram
DisplayPositionned	getTitle()
String	getWarningOrError()
boolean	hasUrl() Check if the Diagram have some links.
boolean	isOk()
void	makeDiagramReady()
long	seed()
void	setSource(UmlSource source)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.plantuml.core.Diagram

getDescription

Constructor Detail

AbstractPSystem

public AbstractPSystem()

Method Detail

getMetadata

public final String getMetadata()

Specified by:

getMetadata in interface Diagram

getSource

public final UmlSource getSource()

Description copied from interface: Diagram

The original source of the diagram

Specified by:

getSource in interface Diagram

Returns:

seed

public final long seed()

setSource

public final void setSource(UmlSource source)

getNbImages

public int getNbImages()

Description copied from interface: Diagram

Number of images in this diagram (usually, 1)

Specified by:

getNbImages in interface Diagram

Returns:

usually 1

getTitle

public DisplayPositionned getTitle()

getWarningOrError

public String getWarningOrError()

Specified by:

getWarningOrError in interface Diagram

checkFinalError

public String checkFinalError()

makeDiagramReady

public void makeDiagramReady()

isOk

public boolean isOk()

executeCommand

public CommandExecutionResult executeCommand(Command cmd,
                                             BlocLines lines)

hasUrl

public boolean hasUrl()

Description copied from interface: Diagram

Check if the Diagram have some links.

Specified by:

hasUrl in interface Diagram

Returns:

exportDiagram

public final ImageData exportDiagram(OutputStream os,
                                     int index,
                                     FileFormatOption fileFormatOption)
                              throws IOException

Description copied from interface: Diagram

Export the diagram as an image to some format. Note that a diagram could be drawn as several images (think about new page for sequence diagram for example).

Specified by:

exportDiagram in interface Diagram

Parameters:

os - where to write the image

index - usually 0 (index of the image to be exported for this diagram).

fileFormatOption - file format to use

Returns:

a description of the generated image

Throws:

IOException

exportDiagramNow

protected abstract ImageData exportDiagramNow(OutputStream os,
                                              int index,
                                              FileFormatOption fileFormatOption,
                                              long seed)
                                       throws IOException

Throws:

IOException