org.objectweb.jorm.metainfo.lib
Class BasicClassRef

java.lang.Object
  |
  +--org.objectweb.jorm.metainfo.lib.BasicClassRef

All Implemented Interfaces:

ClassRef, Loggable, MetaObject, Reference, java.io.Serializable, TypedElement

public class BasicClassRef

extends java.lang.Object

implements ClassRef, Loggable

BasicClassRef defines a reference to a class which is class field. This object is created by the Class object to define its fields.

Author:

X. Spengler

See Also:

Serialized Form

Constructor Summary

BasicClassRef(java.lang.String fieldName, Class currentClass, MetaObject parent)
Builds a new BasicClassRef object.

Method Summary

NameDef	createNameDef() Creates a new NameDef object for the current reference class object.
java.lang.String	getClassName() Returns the name of the class ref.
org.objectweb.util.monolog.api.Logger	getLogger() Returns a logger to an component that wants to log things.
org.objectweb.util.monolog.api.LoggerFactory	getLoggerFactory() Returns a logger factory that allows the creation of new loggers.
Class	getMOClass() Returns the Class object which describes the ClassRef entity.
java.lang.String	getName() Returns the name of the current typed element.
NameDef	getNameDef(java.lang.String mappingName) Returns a NameDef object from a given mappingName.
MetaObject	getParent() Allows to know the parent MetaObject of the current MetaObject.
PType	getType() Allows to know the type of the field.
java.util.Iterator	iterateNameDef() Returns an iterator on existing NameDef for the current Class.
void	setLogger(org.objectweb.util.monolog.api.Logger logger) Defines a logger object.
void	setLoggerFactory(org.objectweb.util.monolog.api.LoggerFactory loggerFactory) Defines the logger factory to obtain new logger.
void	setParent(MetaObject itsParent) Set the parent of the current meta object if it is not yet done by the constructor of the meta object

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicClassRef

public BasicClassRef(java.lang.String fieldName,
                     Class currentClass,
                     MetaObject parent)

Builds a new BasicClassRef object. This object is defined by its name, the reference to the class and its parent.

Parameters:

fieldName - the string representation of the field name

class_ - the reference to the class

parent - the parent of the current object

Method Detail

getMOClass

public Class getMOClass()

Returns the Class object which describes the ClassRef entity. This object is used as the type of a field.

Specified by:

getMOClass in interface ClassRef

Returns:

the Class Object contained by the current class ref object

getClassName

public java.lang.String getClassName()

Returns the name of the class ref.

Specified by:

getClassName in interface ClassRef

Returns:

the name of the class reference meta object

getParent

public MetaObject getParent()

Allows to know the parent MetaObject of the current MetaObject.

Specified by:

getParent in interface MetaObject

Returns:

the MetaObject corresponding to the parent of the current object. If there is no parent, null is returned

setParent

public void setParent(MetaObject itsParent)

Set the parent of the current meta object if it is not yet done by the constructor of the meta object

Specified by:

setParent in interface MetaObject

Parameters:

itsParent - the parent MetaObject of the current object

getName

public java.lang.String getName()

Returns the name of the current typed element.

Specified by:

getName in interface TypedElement

Returns:

the string representation of the typed element

getType

public PType getType()

Allows to know the type of the field.

Specified by:

getType in interface TypedElement

Returns:

a PType object which defines the type of the current field

createNameDef

public NameDef createNameDef()

Creates a new NameDef object for the current reference class object. If this NameDef already exists for the current object, it is returned, in other case, a new NameDef object is created and returned.

Specified by:

createNameDef in interface Reference

Parameters:

nameDefName - the name of the nameDef read in the persistence description file

isSystem - true, the namedef is defined outside jorm, and false, the namedef is define inside jorm

Returns:

a new object used to describe the name projection for the current reference class, or an existing one if it already exists

getNameDef

public NameDef getNameDef(java.lang.String mappingName)

Returns a NameDef object from a given mappingName. If the namedef does not exist, null is returned.

Specified by:

getNameDef in interface Reference

Parameters:

mappingName - the name of the mapping

Returns:

an existing namedef object if exists, either null

iterateNameDef

public java.util.Iterator iterateNameDef()

Returns an iterator on existing NameDef for the current Class. This method returns an empty iterator if no namedef exists in this Class.

Specified by:

iterateNameDef in interface Reference

Returns:

an iterator on NameDef, or an empty iterator if no namedef is defined

setLogger

public void setLogger(org.objectweb.util.monolog.api.Logger logger)

Defines a logger object.

Specified by:

setLogger in interface Loggable

Parameters:

logger - the logger object

setLoggerFactory

public void setLoggerFactory(org.objectweb.util.monolog.api.LoggerFactory loggerFactory)

Defines the logger factory to obtain new logger.

Specified by:

setLoggerFactory in interface Loggable

Parameters:

loggerFactory - the LoggerFactory object to obtain a logger object

getLogger

public org.objectweb.util.monolog.api.Logger getLogger()

Description copied from interface: Loggable

Returns a logger to an component that wants to log things.

Specified by:

getLogger in interface Loggable

Following copied from interface: org.objectweb.jorm.util.api.Loggable

Parameters:

logger - the logger object

getLoggerFactory

public org.objectweb.util.monolog.api.LoggerFactory getLoggerFactory()

Description copied from interface: Loggable

Returns a logger factory that allows the creation of new loggers.

Specified by:

getLoggerFactory in interface Loggable

Following copied from interface: org.objectweb.jorm.util.api.Loggable

Parameters:

loggerfactory - the LoggerFactory object to obtain new loggers