org.hibernate.tool.hbm2x.pojo
Interface POJOClass

All Superinterfaces:
ImportContext
All Known Implementing Classes:
BasicPOJOClass, ComponentPOJOClass, EntityPOJOClass

public interface POJOClass
extends ImportContext

Wrapper class over PersistentClass used in hbm2java and hbm2doc tool

Author:
max, Amit Bhayani

Method Summary
 String generateAnnColumnAnnotation(org.hibernate.mapping.Property property)
           
 String generateAnnIdGenerator()
           
 String generateAnnTableUniqueConstraint()
           
 String generateBasicAnnotation(org.hibernate.mapping.Property property)
           
 String generateEquals(String thisName, String otherName, boolean useGenerics)
           
 Iterator getAllPropertiesIterator()
           
 String getClassJavaDoc(String fallback, int indent)
          Returns the javadoc associated with the class.
 String getClassModifiers()
           
 String getDeclarationName()
           
 String getDeclarationType()
           
 Object getDecoratedObject()
           
 Iterator getEqualsHashCodePropertiesIterator()
           
 String getExtends()
           
 String getExtendsDeclaration()
           
 String getExtraClassCode()
           
 String getFieldDescription(org.hibernate.mapping.Property property)
           
 String getFieldInitialization(org.hibernate.mapping.Property p, boolean useGenerics)
           
 String getFieldJavaDoc(org.hibernate.mapping.Property property, int indent)
           
 org.hibernate.mapping.Property getIdentifierProperty()
           
 String getImplements()
           
 String getImplementsDeclaration()
           
 String getJavaTypeName(org.hibernate.mapping.Property p, boolean useGenerics)
           
 String getPackageDeclaration()
          Returns "package packagename;" where packagename is either the declared packagename, or the one provide via meta attribute "generated-class".
 String getPackageName()
           
 List getPropertiesForFullConstructor()
           
 List getPropertiesForMinimalConstructor()
           
 List getPropertyClosureForFullConstructor()
           
 List getPropertyClosureForMinimalConstructor()
           
 List getPropertyClosureForSuperclassFullConstructor()
           
 List getPropertyClosureForSuperclassMinimalConstructor()
           
 String getQualifiedDeclarationName()
           
 String getShortName()
           
 POJOClass getSuperClass()
           
 Iterator getToStringPropertiesIterator()
           
 org.hibernate.mapping.Property getVersionProperty()
           
 boolean hasIdentifierProperty()
           
 boolean hasVersionProperty()
           
 boolean isComponent()
           
 boolean isInterface()
           
 boolean isSubclass()
           
 boolean needsEqualsHashCode()
           
 boolean needsFullConstructor()
           
 boolean needsMinimalConstructor()
           
 boolean needsToString()
           
 
Methods inherited from interface org.hibernate.tool.hbm2x.pojo.ImportContext
generateImports, importType, staticImport
 

Method Detail

getPackageDeclaration

String getPackageDeclaration()
Returns "package packagename;" where packagename is either the declared packagename, or the one provide via meta attribute "generated-class". Returns "// default package" if no package declarition available.

Parameters:
cm -
tool - TODO
Returns:

getClassModifiers

String getClassModifiers()

getQualifiedDeclarationName

String getQualifiedDeclarationName()

getClassJavaDoc

String getClassJavaDoc(String fallback,
                       int indent)
Returns the javadoc associated with the class.

Parameters:
fallback - the default text if nothing else is found
indent - how many spaces should be added
Returns:

getDeclarationType

String getDeclarationType()
Returns:
declaration type "interface" or "class"

getDeclarationName

String getDeclarationName()
Returns:
unqualified classname for this class (can be changed by meta attribute "generated-class")

getImplementsDeclaration

String getImplementsDeclaration()

getImplements

String getImplements()

getExtendsDeclaration

String getExtendsDeclaration()

getExtends

String getExtends()

generateEquals

String generateEquals(String thisName,
                      String otherName,
                      boolean useGenerics)

isComponent

boolean isComponent()

getExtraClassCode

String getExtraClassCode()

needsEqualsHashCode

boolean needsEqualsHashCode()

hasIdentifierProperty

boolean hasIdentifierProperty()

generateAnnColumnAnnotation

String generateAnnColumnAnnotation(org.hibernate.mapping.Property property)

generateAnnIdGenerator

String generateAnnIdGenerator()

generateAnnTableUniqueConstraint

String generateAnnTableUniqueConstraint()

generateBasicAnnotation

String generateBasicAnnotation(org.hibernate.mapping.Property property)

getAllPropertiesIterator

Iterator getAllPropertiesIterator()

getPackageName

String getPackageName()

getShortName

String getShortName()

getToStringPropertiesIterator

Iterator getToStringPropertiesIterator()

getEqualsHashCodePropertiesIterator

Iterator getEqualsHashCodePropertiesIterator()

needsToString

boolean needsToString()

getFieldJavaDoc

String getFieldJavaDoc(org.hibernate.mapping.Property property,
                       int indent)

getFieldDescription

String getFieldDescription(org.hibernate.mapping.Property property)

getDecoratedObject

Object getDecoratedObject()

isInterface

boolean isInterface()

isSubclass

boolean isSubclass()

getPropertiesForFullConstructor

List getPropertiesForFullConstructor()

getPropertyClosureForFullConstructor

List getPropertyClosureForFullConstructor()

getPropertyClosureForSuperclassFullConstructor

List getPropertyClosureForSuperclassFullConstructor()

needsMinimalConstructor

boolean needsMinimalConstructor()

needsFullConstructor

boolean needsFullConstructor()

getPropertiesForMinimalConstructor

List getPropertiesForMinimalConstructor()

getPropertyClosureForMinimalConstructor

List getPropertyClosureForMinimalConstructor()

getPropertyClosureForSuperclassMinimalConstructor

List getPropertyClosureForSuperclassMinimalConstructor()

getSuperClass

POJOClass getSuperClass()

getJavaTypeName

String getJavaTypeName(org.hibernate.mapping.Property p,
                       boolean useGenerics)

getFieldInitialization

String getFieldInitialization(org.hibernate.mapping.Property p,
                              boolean useGenerics)

getIdentifierProperty

org.hibernate.mapping.Property getIdentifierProperty()

hasVersionProperty

boolean hasVersionProperty()

getVersionProperty

org.hibernate.mapping.Property getVersionProperty()