org.primordion.xholon.io
Interface IXmi2Xholon

All Known Implementing Classes:

Xmi2Xholon

public interface IXmi2Xholon

Transform XMI-formatted files into Xholon format.

Since:

0.7 (Created on July 30, 2007)

Author:

Ken Webb

Field Summary

static int	XMI2XH_ENVIRONMENT_APP
static int	XMI2XH_ENVIRONMENT_DEFAULT
static int	XMI2XH_ENVIRONMENT_ECLIPSEPLUGIN
static int	XMI2XH_TRANSFORM_TYPE_ALL Create all XML and Java files, except for the ClassNames text and GridPanel Java file.
static int	XMI2XH_TRANSFORM_TYPE_CD Create ClassDetails XML file only.
static int	XMI2XH_TRANSFORM_TYPE_CE Create ClassEnum Java file only.
static int	XMI2XH_TRANSFORM_TYPE_CN Create ClassNames text file only.
static int	XMI2XH_TRANSFORM_TYPE_CSH Create CompositeStructureHierarchy XML file only.
static int	XMI2XH_TRANSFORM_TYPE_IH Create InheritanceHierarchy XML file only.
static int	XMI2XH_TRANSFORM_TYPE_INFO Create Information XML file only.
static int	XMI2XH_TRANSFORM_TYPE_JA Create App Java file only.
static int	XMI2XH_TRANSFORM_TYPE_JG Create GridPanel Java file only.
static int	XMI2XH_TRANSFORM_TYPE_JX Create Xh Java file only.
static int	XMI2XH_TRANSFORM_TYPE_XHN Create _xhn XML file only.

Method Summary

boolean	compile(java.lang.String className) Compile a generated Java class.
void	setRootPath(java.lang.String rootPath) Set the root path.
void	setRuntimeEnv(int runtimeEnv) Set the runtime environment.
void	setShouldCompile(boolean shouldCompile) Set whether the generated code should be compiled.
void	setXholonJarPath(java.lang.String xholonJarPath) Set the Xholon jar path, for use by the compiler.
boolean	xmi2xh(java.lang.String toolName, int transformType, java.lang.String xmiFileName, java.lang.String rootXholon) Transform the model, and optionally compile the generated Java classes.

Field Detail

XMI2XH_TRANSFORM_TYPE_IH

public static final int XMI2XH_TRANSFORM_TYPE_IH

Create InheritanceHierarchy XML file only.

See Also:

Constant Field Values

XMI2XH_TRANSFORM_TYPE_CE

public static final int XMI2XH_TRANSFORM_TYPE_CE

Create ClassEnum Java file only.

See Also:

Constant Field Values

XMI2XH_TRANSFORM_TYPE_CSH

public static final int XMI2XH_TRANSFORM_TYPE_CSH

Create CompositeStructureHierarchy XML file only.

See Also:

Constant Field Values

XMI2XH_TRANSFORM_TYPE_CD

public static final int XMI2XH_TRANSFORM_TYPE_CD

Create ClassDetails XML file only.

See Also:

Constant Field Values

XMI2XH_TRANSFORM_TYPE_JX

public static final int XMI2XH_TRANSFORM_TYPE_JX

Create Xh Java file only.

See Also:

Constant Field Values

XMI2XH_TRANSFORM_TYPE_JA

public static final int XMI2XH_TRANSFORM_TYPE_JA

Create App Java file only.

See Also:

Constant Field Values

XMI2XH_TRANSFORM_TYPE_JG

public static final int XMI2XH_TRANSFORM_TYPE_JG

Create GridPanel Java file only.

See Also:

Constant Field Values

XMI2XH_TRANSFORM_TYPE_INFO

public static final int XMI2XH_TRANSFORM_TYPE_INFO

Create Information XML file only.

See Also:

Constant Field Values

XMI2XH_TRANSFORM_TYPE_XHN

public static final int XMI2XH_TRANSFORM_TYPE_XHN

Create _xhn XML file only.

See Also:

Constant Field Values

XMI2XH_TRANSFORM_TYPE_ALL

public static final int XMI2XH_TRANSFORM_TYPE_ALL

Create all XML and Java files, except for the ClassNames text and GridPanel Java file.

See Also:

Constant Field Values

XMI2XH_TRANSFORM_TYPE_CN

public static final int XMI2XH_TRANSFORM_TYPE_CN

Create ClassNames text file only.

See Also:

Constant Field Values

XMI2XH_ENVIRONMENT_APP

public static final int XMI2XH_ENVIRONMENT_APP

See Also:

Constant Field Values

XMI2XH_ENVIRONMENT_ECLIPSEPLUGIN

public static final int XMI2XH_ENVIRONMENT_ECLIPSEPLUGIN

See Also:

Constant Field Values

XMI2XH_ENVIRONMENT_DEFAULT

public static final int XMI2XH_ENVIRONMENT_DEFAULT

See Also:

Constant Field Values

Method Detail

setRuntimeEnv

public void setRuntimeEnv(int runtimeEnv)

Set the runtime environment.

Parameters:

runtimeEnv - Whether this is a standard Java app, or an Eclipse plugin.

setRootPath

public void setRootPath(java.lang.String rootPath)

Set the root path.

Parameters:

rootPath - An absolute or relative root, from which transform config src bin derive.

setShouldCompile

public void setShouldCompile(boolean shouldCompile)

Set whether the generated code should be compiled.

Parameters:

shouldCompile - true or false

setXholonJarPath

public void setXholonJarPath(java.lang.String xholonJarPath)

Set the Xholon jar path, for use by the compiler.

Parameters:

xholonJarPath -

xmi2xh

public boolean xmi2xh(java.lang.String toolName,
                      int transformType,
                      java.lang.String xmiFileName,
                      java.lang.String rootXholon)

Transform the model, and optionally compile the generated Java classes.

Parameters:

toolName - The name of the modeling tool (ex: Topcased MagicDraw Poseidon ArgoUML TopcasedSysML).

transformType - One of ih|ce|cs|cd|jx|ja|jg|in|xhn|all|cn

xmiFileName - The name of the input XMI-formatted file (ex: HelloWorldTutorial.uml).

rootXholon - The root of the composite structure hierarchy, or null.

compile

public boolean compile(java.lang.String className)

Compile a generated Java class.

Parameters:

className - Name of the class to compile.

Returns:

true or false