|
OpenMMS V1.5.1 Std |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.rcsb.openmms.meta.Trans | +--org.rcsb.openmms.meta.FieldTrans
Class for "Fields" in Cif Metamodel
Field Summary | |
protected java.lang.String |
columnIndexName
|
protected java.lang.String |
columnName
names for building sql tables |
protected java.lang.String |
copyName
Name of "extra" copy used in constructing symetric matrices |
int |
descriptionParagraphs
|
protected java.lang.String |
fieldType
Non-Cif fields must explictly declare their type |
protected java.lang.String |
fullFieldName
prefixed with list of embedded field structure names using "." |
protected java.lang.String |
fullRefName
prefixed with list of embedded field structure names using "_" |
static int |
IS_A_STREAM_DATATYPE
|
protected boolean |
isCifField
|
protected boolean |
pseudoField
Indicates fields used to roll-up vectors and matrices in mmCIF into the correct Vectore and Matrix3 structures |
protected java.lang.String |
realName
"real" name used to generate vector/matrix code that correctly indexes values with "n" instead of "n+1" |
protected StructureTrans |
structType
Pointer to the structure node when a structure type used as a field element. |
Constructor Summary | |
FieldTrans(java.lang.String n)
|
|
FieldTrans(java.lang.String varname,
java.lang.String cifname)
|
|
FieldTrans(java.lang.String rtype,
java.lang.String varname,
boolean icf)
|
|
FieldTrans(java.lang.String varname,
java.lang.String cifname,
int descp)
|
|
FieldTrans(StructureTrans st,
java.lang.String varname)
Constructor used for embedded structs |
Method Summary | |
void |
accept(TransVisitor v)
|
java.lang.String |
cifNameToTagName(java.lang.String cname)
Converts the left brackets and periods to underbars and deletes the right brackets |
protected java.lang.String |
computeFullName(char c)
Overridded by SubfieldTrans and MatrixTrans For Fields and Subfields this will return the name of a basic type only if getFieldStructure() returns null. |
void |
computeNames()
|
java.lang.String |
getCifItemName()
This method must return a valid mmCIF dictionary reference |
FieldTrans |
getCifParentIndex()
|
java.lang.String |
getColumnIndexName()
|
java.lang.String |
getColumnName()
|
FieldTrans |
getContainingField()
|
java.lang.String |
getCopyName()
|
DictionaryItem |
getDictionaryItem()
|
StructureTrans |
getFieldStructure()
for fields that are of type struct, returns a pointer to the struct declaration; otherwise returns null |
java.lang.String |
getFieldType()
returns a string representing the type of this field type |
java.lang.String |
getFieldType(ModuleTrans inMod)
returns a string representing the type of this field If the type is a structure name, then the fully qualified name will be returned if the structure is not in the current module as specified by inMod. |
java.lang.String |
getFlagName()
|
java.lang.String |
getFullFieldName()
|
java.lang.String |
getFullRefName()
|
java.lang.String |
getRealName()
|
StructureTrans |
getStructure()
|
java.lang.String |
getTagName()
|
boolean |
isCifField()
|
boolean |
isFieldBitSet(int f)
|
boolean |
isIndexField()
|
boolean |
isLeaf()
A leaf field node is anything that does not have a structure type, and therefore never has children. |
boolean |
isPseudoField()
Pseudo Fields represent the individual elements in an array (e.g. the unrolled mmCIF vectors/matrices) |
void |
setCifParentIndex(FieldTrans p)
|
void |
setColumnIndexName(java.lang.String s)
|
void |
setColumnName(java.lang.String s)
|
void |
setCopyName(java.lang.String s)
|
void |
setDictionaryItem(DictionaryItem di)
|
void |
setFieldBit(int f)
|
void |
setFieldStructure(StructureTrans st)
|
void |
setPseudoField(boolean pf)
Pseudo Fields represent the individual elements in an array (e.g. the unrolled mmCIF vectors/matrices) |
void |
setRealName(java.lang.String s)
|
void |
setStructure(StructureTrans st)
|
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 |
protected java.lang.String realName
protected java.lang.String fullFieldName
protected java.lang.String fullRefName
protected java.lang.String copyName
protected java.lang.String columnName
protected java.lang.String columnIndexName
protected boolean isCifField
protected java.lang.String fieldType
protected StructureTrans structType
protected boolean pseudoField
public static final int IS_A_STREAM_DATATYPE
public int descriptionParagraphs
Constructor Detail |
public FieldTrans(java.lang.String n)
public FieldTrans(java.lang.String varname, java.lang.String cifname)
public FieldTrans(java.lang.String rtype, java.lang.String varname, boolean icf)
public FieldTrans(StructureTrans st, java.lang.String varname)
public FieldTrans(java.lang.String varname, java.lang.String cifname, int descp)
Method Detail |
public void accept(TransVisitor v) throws java.io.IOException, TransGenException
accept
in class Trans
java.io.IOException
TransGenException
public void setStructure(StructureTrans st)
public StructureTrans getStructure()
public void setDictionaryItem(DictionaryItem di)
public DictionaryItem getDictionaryItem()
public java.lang.String getCifItemName()
public void setPseudoField(boolean pf)
public boolean isPseudoField()
public boolean isCifField()
public void computeNames()
protected java.lang.String computeFullName(char c)
public java.lang.String getFullFieldName()
public java.lang.String getFullRefName()
public boolean isLeaf()
public void setFieldStructure(StructureTrans st)
public StructureTrans getFieldStructure()
public java.lang.String getFieldType()
public java.lang.String getFieldType(ModuleTrans inMod)
public java.lang.String getFlagName()
public java.lang.String getTagName()
public void setRealName(java.lang.String s)
public java.lang.String getRealName()
public void setCopyName(java.lang.String s)
public java.lang.String getCopyName()
public void setColumnName(java.lang.String s)
public java.lang.String getColumnName()
public void setColumnIndexName(java.lang.String s)
public java.lang.String getColumnIndexName()
public FieldTrans getContainingField()
public void setCifParentIndex(FieldTrans p)
public boolean isIndexField()
public FieldTrans getCifParentIndex()
public void setFieldBit(int f)
public boolean isFieldBitSet(int f)
public java.lang.String cifNameToTagName(java.lang.String cname)
|
OpenMMS V1.5.1 Std |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |