org.rcsb.openmms.meta
Class RootTrans

java.lang.Object
  |
  +--org.rcsb.openmms.meta.Trans
        |
        +--org.rcsb.openmms.meta.RootTrans

Direct Known Subclasses:

AllRootTrans, CompactRootTrans, DevRootTrans, LsrRootTrans, StdRootTrans, TestRootTrans

public abstract class RootTrans

extends Trans

Class for the "Root" of the mmCIF translation metamodel

Version:

1.5

Author:

Douglas S. Greer

Field Summary

protected StructureTrans	atomIndex
static java.lang.String	baseModuleName
protected static boolean	COMPILER_IMPLEMENTS_VALUETYPES COMPILER_HAS_VALUETYPES is true if the IDL compiler being used can handle valuetype declarations.
static java.lang.String	coreModuleName
protected StructureTrans	millerIndices
protected StructureTrans	seqIndex
protected StructureTrans	stIndexId
protected StructureTrans	stVectorXYZ
protected StructureTrans	unitCell
protected static boolean	USE_VALUETYPES USE_VALUETYPES determines if structs or valuetypes are used for default mmCIF category container
static java.lang.String	vFieldAccess
static java.lang.String	vTypeName

Constructor Summary

RootTrans(java.lang.String baseModName)

Method Summary

void	accept(TransVisitor v)
protected ModuleTrans	createIdlFile(int number, java.lang.String base, java.lang.String ext, java.lang.String var, ModuleTrans core)
StructureTrans	defaultContainer(java.lang.String sname, CategoryTrans ct)
StructureTrans	defaultContainer(java.lang.String sname, CategoryTrans ct, int descp)
StructureTrans	defaultContainer(java.lang.String sname, CategoryTrans ct, ModuleTrans[] mq)
StructureTrans	defaultContainer(java.lang.String sname, CategoryTrans ct, ModuleTrans[] mq, int descp)
StructureTrans	defaultContainer(java.lang.String sname, ModuleTrans[] mq, boolean isCif)
abstract void	doCoreModDefs(ModuleTrans mod)
abstract void	doDepoModDefs(ModuleTrans mod)
void	doEntry(ModuleTrans cmod)
void	doExceptions(ModuleTrans cmod)
void	doFlags(ModuleTrans cmod)
void	doMMSServer(ModuleTrans cmod)
abstract void	doNmrModDefs(ModuleTrans mod)
void	doNmrTypeDefs(ModuleTrans cmod, ModuleTrans[] modQual)
void	doOpening(ModuleTrans cmod)
abstract void	doReferModDefs(ModuleTrans mod)
void	doTypeDefs(ModuleTrans cmod)
abstract void	doXRayModDefs(ModuleTrans mod)
void	doXRayTypeDefs(ModuleTrans cmod, ModuleTrans[] modQual)
protected void	finIdlFile(ModuleTrans mod)
abstract java.lang.String	getModelIdentifier()
abstract java.lang.String	getRevisionNumber()
void	init(java.lang.String baseModName)

Methods inherited from class org.rcsb.openmms.meta.Trans

add, convertToFlagName, convertToUnderbar, getBlankLines, getChild, getComment, getName, getTransType, numberOfChildren, replace, setBlankLines, setComment, setTransType

Methods inherited from class java.lang.Object

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

Field Detail

COMPILER_IMPLEMENTS_VALUETYPES

protected static final boolean COMPILER_IMPLEMENTS_VALUETYPES

COMPILER_HAS_VALUETYPES is true if the IDL compiler being used can handle valuetype declarations. Set to false if valuetypes are not available and "vtype" typedef'ed as a struct will be used instead.

See Also:

Constant Field Values

USE_VALUETYPES

protected static final boolean USE_VALUETYPES

USE_VALUETYPES determines if structs or valuetypes are used for default mmCIF category container

See Also:

Constant Field Values

baseModuleName

public static java.lang.String baseModuleName

coreModuleName

public static java.lang.String coreModuleName

vTypeName

public static java.lang.String vTypeName

vFieldAccess

public static java.lang.String vFieldAccess

stIndexId

protected StructureTrans stIndexId

stVectorXYZ

protected StructureTrans stVectorXYZ

seqIndex

protected StructureTrans seqIndex

atomIndex

protected StructureTrans atomIndex

unitCell

protected StructureTrans unitCell

millerIndices

protected StructureTrans millerIndices

Constructor Detail

RootTrans

public RootTrans(java.lang.String baseModName)

Method Detail

doCoreModDefs

public abstract void doCoreModDefs(ModuleTrans mod)

doReferModDefs

public abstract void doReferModDefs(ModuleTrans mod)

doXRayModDefs

public abstract void doXRayModDefs(ModuleTrans mod)

doNmrModDefs

public abstract void doNmrModDefs(ModuleTrans mod)

doDepoModDefs

public abstract void doDepoModDefs(ModuleTrans mod)

accept

public void accept(TransVisitor v)
            throws java.io.IOException,
                   TransGenException

Specified by:

accept in class Trans

java.io.IOException

TransGenException

getModelIdentifier

public abstract java.lang.String getModelIdentifier()

getRevisionNumber

public abstract java.lang.String getRevisionNumber()

init

public void init(java.lang.String baseModName)

createIdlFile

protected ModuleTrans createIdlFile(int number,
                                    java.lang.String base,
                                    java.lang.String ext,
                                    java.lang.String var,
                                    ModuleTrans core)

finIdlFile

protected void finIdlFile(ModuleTrans mod)

doOpening

public void doOpening(ModuleTrans cmod)

doExceptions

public void doExceptions(ModuleTrans cmod)

doTypeDefs

public void doTypeDefs(ModuleTrans cmod)

doXRayTypeDefs

public void doXRayTypeDefs(ModuleTrans cmod,
                           ModuleTrans[] modQual)

doNmrTypeDefs

public void doNmrTypeDefs(ModuleTrans cmod,
                          ModuleTrans[] modQual)

doFlags

public void doFlags(ModuleTrans cmod)

doEntry

public void doEntry(ModuleTrans cmod)

doMMSServer

public void doMMSServer(ModuleTrans cmod)

defaultContainer

public StructureTrans defaultContainer(java.lang.String sname,
                                       ModuleTrans[] mq,
                                       boolean isCif)

defaultContainer

public StructureTrans defaultContainer(java.lang.String sname,
                                       CategoryTrans ct)

defaultContainer

public StructureTrans defaultContainer(java.lang.String sname,
                                       CategoryTrans ct,
                                       int descp)

defaultContainer

public StructureTrans defaultContainer(java.lang.String sname,
                                       CategoryTrans ct,
                                       ModuleTrans[] mq)

defaultContainer

public StructureTrans defaultContainer(java.lang.String sname,
                                       CategoryTrans ct,
                                       ModuleTrans[] mq,
                                       int descp)