OBJDoc Repository Document - Development

The data structure representing the repository file is a dictionary created by the class OJBDocumenter. The dictionary, generally called document in the program, is a dictionary of dictionaries and lists. It is first created by an XML parsing of the OJB repository file.

Each entry in the XML file becomes a dictionary containing its named subelements. If a entry appears more than once, it is represented by a list of dictionaries.

<class-descriptor class="org.kuali.core.bo.ApplicationConstant" table="KULUNT.ER_APPL_CNST_T">
		<field-descriptor name="name" column="APPL_CNST_NM" jdbc-type="VARCHAR"/>
		<field-descriptor name="code" column="APPL_CNST_VAL" jdbc-type="VARCHAR"  primarykey="true"/>
		<field-descriptor name="active" column="DOBJ_MAINT_CD_ACTV_IND" jdbc-type="VARCHAR" conversion="org.kuali.core.util.OjbCharBooleanConversion"/>
		<field-descriptor name="objectId" column="OBJ_ID" jdbc-type="VARCHAR"/>
		<field-descriptor name="versionNumber" column="VER_NBR" jdbc-type="BIGINT" locking="true"/>
</class-descriptor>

becomes

{ 'class_descriptor': 
      { 'class' : 'org.kuali.core.bo.ApplicationConstant',
        'table' : 'KULUNT.ER_APPL_CNST_T',
        'field_descriptor' :
            [
                { 'name' : 'name',
                  'column' : 'APPL_CNST_NM',
                  'jdbc-type' : 'VARCHAR',
                  'primarykey' : 'TRUE' },
                { 'name' : 'code',
                  'column' : 'APPL_CNST_VAL',
                  'jdbc_type' : 'VARCHAR',
                  'primarykey' : 'TRUE' },
                { 'name' : 'active',
                  'column' : 'DOBJ_MAINT_CD_ACTV_IND',
                  'jdbc_type' : 'VARCHAR',
                  'conversion' : 'org.kuali.core.util.OjbCharBooleanConversion' },
                { 'name' : 'objectId',
                  'column' : 'OBJ_ID',
                  'jdbc_type' : 'VARCHAR' },
                { 'name' : 'versionNumber',
                  'column' : 'VER_NBR',
                  'jdbc_type' : 'BIGINT',
                  'locking' : 'true' }
            ]
      }
  }