org.objectweb.speedo.generation.mivisitor
Class ORMappingGenerator.VisitRequired

java.lang.Object
  extended by org.objectweb.speedo.generation.mivisitor.ORMappingGenerator.VisitRequired
Enclosing class:
ORMappingGenerator

public static class ORMappingGenerator.VisitRequired
extends java.lang.Object

This class represents required element to be visited in a persistent class.

Author:
S.Chassande-Barrioz

Field Summary
static ORMappingGenerator.VisitRequired ALL
          constant representing a visit of all elements of a persistent class
 boolean base
          indicates if the base must be visited.
static ORMappingGenerator.VisitRequired BASE
          constant representing a visit of base element of a persistent class
static ORMappingGenerator.VisitRequired NOTHING
          constant representing a visit of nothing
 boolean references
          Indicates if all references must be visisted (ClassRef and GenClassRef)
 SpeedoField refField
          indicates if the visit of a particular reference field is required.
 
Constructor Summary
ORMappingGenerator.VisitRequired(SpeedoField refField)
          Builds a new VisitRequired instance including the base elements and a particular reference field.
 
Method Summary
 java.lang.String toString()
          Prints a string representing the current instance.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NOTHING

public static final ORMappingGenerator.VisitRequired NOTHING
constant representing a visit of nothing


ALL

public static final ORMappingGenerator.VisitRequired ALL
constant representing a visit of all elements of a persistent class


BASE

public static final ORMappingGenerator.VisitRequired BASE
constant representing a visit of base element of a persistent class


base

public boolean base
indicates if the base must be visited. The base represents: - the table of the persistent class - the identifier of the persistent class - the primitivie fields of the persistent class


references

public boolean references
Indicates if all references must be visisted (ClassRef and GenClassRef)


refField

public SpeedoField refField
indicates if the visit of a particular reference field is required. It is often used in case of bi directional relationship with one side of the relation mmped by the other one.

Constructor Detail

ORMappingGenerator.VisitRequired

public ORMappingGenerator.VisitRequired(SpeedoField refField)
Builds a new VisitRequired instance including the base elements and a particular reference field.

Parameters:
refField - the field to visit
Method Detail

toString

public java.lang.String toString()
Prints a string representing the current instance.

Overrides:
toString in class java.lang.Object