org.rcsb.openmms.meta
Class StructureTrans

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

Direct Known Subclasses:

ExceptionTrans, ValuetypeTrans

public class StructureTrans

extends Trans

Class for representing "Structures" in Cif metamodel

Version:

1.4

Author:

Douglas S. Greer

Field Summary

protected java.lang.String	constantFlagName
int	descriptionParagraphs
protected DictionaryCategory	dictCategory
protected boolean	isCifStructure
protected java.lang.String	listVarName
protected boolean	useBlockMethods

Constructor Summary

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

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

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

Method Summary

void	accept(TransVisitor v)
CategoryTrans	getCategory()
DictionaryCategory	getDictionaryCategory()
java.lang.String	getFlagName()
java.lang.String	getFullListVarName()
java.lang.String	getFullyQualifiedName(ModuleTrans ctx) Return a fully qualified (with module name prefixes) structure name that can be used in calling context ctx.
java.lang.String	getListVarName()
ModuleTrans[]	getModuleQualifier()
java.lang.String	getTypeName() Return a name of the Java class (Type) that will be used to declare instances of this Strucute in generated code.
boolean	isCifStructure()
boolean	isValuetype()
void	setDictionaryCategory(DictionaryCategory di)
void	setIsCif(boolean isc)
void	setUseBlockMethod(boolean ubm)
boolean	useBlockMethod()

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

listVarName

protected java.lang.String listVarName

constantFlagName

protected java.lang.String constantFlagName

dictCategory

protected DictionaryCategory dictCategory

isCifStructure

protected boolean isCifStructure

useBlockMethods

protected boolean useBlockMethods

descriptionParagraphs

public int descriptionParagraphs

Constructor Detail

StructureTrans

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

StructureTrans

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

StructureTrans

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

Method Detail

accept

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

Specified by:

accept in class Trans

java.io.IOException

TransGenException

isValuetype

public boolean isValuetype()

getTypeName

public java.lang.String getTypeName()

Return a name of the Java class (Type) that will be used to declare instances of this Strucute in generated code.

getFullyQualifiedName

public java.lang.String getFullyQualifiedName(ModuleTrans ctx)

Return a fully qualified (with module name prefixes) structure name that can be used in calling context ctx.

setIsCif

public void setIsCif(boolean isc)

isCifStructure

public boolean isCifStructure()

setDictionaryCategory

public void setDictionaryCategory(DictionaryCategory di)

getDictionaryCategory

public DictionaryCategory getDictionaryCategory()

getCategory

public CategoryTrans getCategory()

getModuleQualifier

public ModuleTrans[] getModuleQualifier()

getListVarName

public java.lang.String getListVarName()

getFullListVarName

public java.lang.String getFullListVarName()

getFlagName

public java.lang.String getFlagName()

setUseBlockMethod

public void setUseBlockMethod(boolean ubm)

useBlockMethod

public boolean useBlockMethod()