|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A Class interface defines methods to describe a Class meta object. A Class is composed by a set of fields (primitive, reference class or reference generic class), a set of inherited classes, a mapping class, can be abstract or not and has a name.
Method Summary | |
void |
addAllInheritedClass(java.util.Map table)
Constructs an Hashtable with inherited class |
void |
addClassProject(java.lang.String projectName,
ClassProject classProject)
Adds a ClassProject object. |
void |
addInheritedClass(Class class_)
Adds a new inherited class to the list of the inherited classes for the current class object. |
ClassProject |
createClassProject(java.lang.String projectName)
Creates a new ClassProject object. |
ClassRef |
createClassRef(java.lang.String fieldName,
Class class_)
Allows to obtain a new ClassRef from a field name an its class. |
GenClassRef |
createGenClassRef(java.lang.String fieldName,
java.lang.String genName)
Allows to obtain a new GenClassRef from a field name an its generic class. |
ScalarField |
createHiddenField(java.lang.String fieldname,
PType type,
int size)
Creates an hiddenfield for the current Class object. |
NameDef |
createNameDef()
Creates a new NameDef object for the current Class object. |
PrimitiveElement |
createPrimitiveElement(java.lang.String fieldName,
PType type,
int size)
Allows to obtain a new PrimitiveElement from a class field name an its type. |
ClassProject |
getClassProject(java.lang.String projectName)
Returns a ClassProject object. |
java.util.Collection |
getClassProjects()
Returns a collection of ClassProject objects. |
int |
getFieldRefNumber()
Returns the number of fields which are references to classes. |
java.lang.String |
getFileName()
Allows to retrieve the file name of this class MO. |
java.lang.String |
getFQName()
Gets the fully qualified name (including the package name) associated with this class. |
ScalarField |
getHiddenField(java.lang.String fieldname)
Retrieve the hiddenfield identified by its name in the current class. |
int |
getInheritedClassNumber()
Returns the number of inherited classes for the current Class object. |
java.lang.String |
getName()
Allows to know the name of the current class object. |
NameDef |
getNameDef(java.lang.String projectName)
Returns a NameDef object from a given mapperName and mappingName. |
TypedElement |
getTypedElement(java.lang.String fieldName)
Allows to obtain an existing Field. |
boolean |
isAbstract()
Allows to know if the current class is an abstract class or not. |
boolean |
isInherited()
Tests if this class is inherited by another one. |
java.util.Iterator |
iterateAllField()
Returns an iterator on existing class fields + fields from super classes. |
java.util.Iterator |
iterateAllHiddenField()
Provides an iterator over the all the hiddenfield of the class including inherited fields. |
java.util.Iterator |
iterateField()
Returns an iterator on existing class fields. |
java.util.Iterator |
iterateHiddenField()
Provides an iterator over the all the hiddenfield of the class excluding inherited fields. |
java.util.Iterator |
iterateInheritedClass()
Allows to obtain all the inherited classes from the current class object. |
java.util.Iterator |
iterateNameDef()
Returns an iterator on existing NameDef for the current Class. |
ClassProject |
removeClassProject(java.lang.String projectname)
Removes a ClassProject instance. |
TypedElement |
removeTypedElement(java.lang.String fieldName)
Removes a typed element. |
void |
setAbstract(boolean isAbstract)
|
void |
setFileName(java.lang.String filename)
Allows to assign the file name of this class MO. |
void |
setInherited()
Specifies that this class is inherited by another one within the set of compiled ones. |
Methods inherited from interface org.objectweb.jorm.metainfo.api.MetaObject |
getParent, setParent |
Method Detail |
public java.lang.String getFileName()
public void setFileName(java.lang.String filename)
filename
- The file name.public boolean isAbstract()
public void setAbstract(boolean isAbstract)
public java.lang.String getName()
public java.lang.String getFQName()
public TypedElement getTypedElement(java.lang.String fieldName)
fieldName
- the name of the class field
public TypedElement removeTypedElement(java.lang.String fieldName)
fieldName
- is the name of the field to be removed
public NameDef createNameDef()
public ScalarField createHiddenField(java.lang.String fieldname, PType type, int size)
fieldname
- the name of the hiddenfieldtype
- the ptype of the hiddenfield
public java.util.Iterator iterateAllHiddenField()
public java.util.Iterator iterateHiddenField()
public ScalarField getHiddenField(java.lang.String fieldname)
fieldname
- the name of the hiddenfield.
public java.util.Iterator iterateNameDef()
public NameDef getNameDef(java.lang.String projectName)
projectName
- the name of the class project
public PrimitiveElement createPrimitiveElement(java.lang.String fieldName, PType type, int size)
fieldName
- the name of the primitive fieldtype
- the PType of the primitive field
public ClassRef createClassRef(java.lang.String fieldName, Class class_)
fieldName
- the name of the fieldclass_
- the class meta-object which represents the reference of
the field
public GenClassRef createGenClassRef(java.lang.String fieldName, java.lang.String genName)
fieldName
- the name of the fieldgenName
- the GenClass object which represents the reference of
the field
public java.util.Iterator iterateField()
public java.util.Iterator iterateAllField()
public java.util.Iterator iterateInheritedClass()
public void addInheritedClass(Class class_)
class_
- the inherited class to add to inherited classes listpublic int getInheritedClassNumber()
public void addAllInheritedClass(java.util.Map table)
table
- the hashtable to buildpublic int getFieldRefNumber()
public void setInherited()
public boolean isInherited()
public ClassProject getClassProject(java.lang.String projectName)
projectName
- a project name.
public java.util.Collection getClassProjects()
public void addClassProject(java.lang.String projectName, ClassProject classProject)
projectName
- a project name,
classProject a ClassProject object.public ClassProject createClassProject(java.lang.String projectName)
projectName
- the name of the project.
public ClassProject removeClassProject(java.lang.String projectname)
projectname
- is the name of removed ClassProject
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |