DefaultGrailsDomainClass.java
| Index Score | ||
|---|---|---|
 |
 |
org.codehaus.groovy.grails.commons |
 |
 |
Grails |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| EXEC_COMMENTS | Comments in executable code |  |
| LINE_COMMENT | Number of line comments | |
| JAVA0144 | JAVA0144 Line exceeds maximum M characters | |
| EXITS | Procedure exits | |
| COMPARISONS | Number of comparison operators | |
| SIZE | Size of the file in bytes | |
| CYCLOMATIC | Cyclomatic complexity | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| BLOCKS | Number of blocks | |
| OPERATORS | Number of operators | |
| DECL_COMMENTS | Comments in declarations | |
| JAVA0254 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| PROGRAM_LENGTH | Halstead program length | |
| JAVA0049 | JAVA0049 Nested block at depth N (maximum: M) | |
| OPERANDS | Number of operands | |
| UNIQUE_OPERANDS | Number of unique operands | |
| LOOPS | Number of loops | |
| FUNCTIONS | Number of function declarations | |
| JAVA0130 | JAVA0130 Non-static method does not use instance fields | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| LINES | Number of lines in the source file | |
| RETURNS | Number of return points from functions | |
| LOGICAL_LINES | Number of statements | |
| LOC | Lines of code | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| ELOC | Effective lines of code | |
| JAVA0270 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| COMMENTS | Comment lines | |
| JAVA0259 | JAVA0259 Return of collection/array field | |
| NEST_DEPTH | Maximum nesting depth | |
| PARAMS | Number of formal parameter declarations | |
| UNIQUE_OPERATORS | Number of unique operators | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0136 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0179 | JAVA0179 Local variable hides visible field | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0100 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0075 | JAVA0075 Method parameter hides field | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/* Copyright 2004-2005 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.codehaus.groovy.grails.commons;
import groovy.lang.GroovyObject;
import org.apache.commons.lang.ClassUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.codehaus.groovy.grails.exceptions.GrailsDomainException;
import org.codehaus.groovy.grails.exceptions.InvalidPropertyException;
import org.springframework.beans.BeanUtils;
import org.springframework.validation.Validator;
import java.beans.PropertyDescriptor;
import java.beans.IntrospectionException;
import java.lang.reflect.Modifier;
import java.util.*;
/**
* @author Graeme Rocher
* @since 05-Jul-2005
*/
public class DefaultGrailsDomainClass extends AbstractGrailsClass implements GrailsDomainClass {
private static final Log LOG = LogFactory.getLog(DefaultGrailsDomainClass.class);
private GrailsDomainClassProperty identifier;
private GrailsDomainClassProperty version;
private GrailsDomainClassProperty[] properties;
private GrailsDomainClassProperty[] persistentProperties;
private Map propertyMap;
private Map relationshipMap;
private Map constraints = new HashMap();
private Map mappedBy;
private Validator validator;
private String mappingStrategy = GrailsDomainClass.GORM;
private List owners = new ArrayList();
private boolean root = true;
private Set subClasses = new HashSet();
private Collection embedded;
public DefaultGrailsDomainClass(Class clazz) {
super(clazz, "");
PropertyDescriptor[] propertyDescriptors = getReference().getPropertyDescriptors();
if(!clazz.getSuperclass().equals( GroovyObject.class ) &&
!clazz.getSuperclass().equals(Object.class) &&
!Modifier.isAbstract(clazz.getSuperclass().getModifiers())) {
this.root = false;
}
this.propertyMap = new LinkedHashMap();
this.relationshipMap = getAssociationMap();
this.embedded = getEmbeddedList();
// get mapping strategy by setting
if(getPropertyOrStaticPropertyOrFieldValue(GrailsDomainClassProperty.MAPPING_STRATEGY, String.class) != null)
this.mappingStrategy = (String)getPropertyOrStaticPropertyOrFieldValue(GrailsDomainClassProperty.MAPPING_STRATEGY, String.class);
// get any mappedBy settings
this.mappedBy = (Map)getPropertyOrStaticPropertyOrFieldValue(GrailsDomainClassProperty.MAPPED_BY, Map.class);
if(this.mappedBy == null)this.mappedBy = Collections.EMPTY_MAP;
// establish the owners of relationships
establishRelationshipOwners();
// First go through the properties of the class and create domain properties
// populating into a map
populateDomainClassProperties(propertyDescriptors);
// if no identifier property throw exception
if(this.identifier == null) {
throw new GrailsDomainException("Identity property not found, but required in domain class ["+getFullName()+"]" );
}
// if no version property throw exception
if(this.version == null) {
throw new GrailsDomainException("Version property not found, but required in domain class ["+getFullName()+"]" );
}
// set properties from map values
this.properties = (GrailsDomainClassProperty[])this.propertyMap.values().toArray( new GrailsDomainClassProperty[this.propertyMap.size()] );
// establish relationships
establishRelationships();
// set persistent properties
establishPersistentProperties();
// process the constraints
try {
this.constraints = GrailsDomainConfigurationUtil.evaluateConstraints(getReference().getWrappedInstance(), this.persistentProperties);
} catch (IntrospectionException e) {
LOG.error("Error reading class ["+getClazz()+"] constraints: " +e .getMessage(), e);
}
}
public boolean hasSubClasses() {
return getSubClasses().size() > 0;
}
/**
* calculates the persistent properties from the evaluated properties
*/
private void establishPersistentProperties() {
Collection tempList = new ArrayList();
for(Iterator i = this.propertyMap.values().iterator();i.hasNext();) {
GrailsDomainClassProperty currentProp = (GrailsDomainClassProperty)i.next();
if(currentProp.getType() != Object.class && currentProp.isPersistent() && !currentProp.isIdentity() && !currentProp.getName().equals( GrailsDomainClassProperty.VERSION )) {
tempList.add(currentProp);
}
}
this.persistentProperties = (GrailsDomainClassProperty[])tempList.toArray( new GrailsDomainClassProperty[tempList.size()]);
}
/**
* Evaluates the belongsTo property to find out who owns who
*/
private void establishRelationshipOwners() {
Class belongsTo = (Class)getPropertyOrStaticPropertyOrFieldValue(GrailsDomainClassProperty.BELONGS_TO, Class.class);
if(belongsTo == null) {
List ownersProp = (List)getPropertyOrStaticPropertyOrFieldValue(GrailsDomainClassProperty.BELONGS_TO, List.class);
if(ownersProp != null) {
this.owners = ownersProp;
}
else {
Map ownersMap = (Map)getPropertyOrStaticPropertyOrFieldValue(GrailsDomainClassProperty.BELONGS_TO, Map.class);
if(ownersMap!=null) {
this.owners = new ArrayList(ownersMap.values());
}
}
}
else {
this.owners = new ArrayList();
this.owners.add(belongsTo);
}
}
/**
* Populates the domain class properties map
*
* @param propertyDescriptors The property descriptors
*/
private void populateDomainClassProperties(PropertyDescriptor[] propertyDescriptors) {
for(int i = 0; i < propertyDescriptors.length; i++) {
PropertyDescriptor descriptor = propertyDescriptors[i];
// ignore certain properties
if(GrailsDomainConfigurationUtil.isNotConfigurational(descriptor) ) {
GrailsDomainClassProperty property = new DefaultGrailsDomainClassProperty(this, descriptor);
this.propertyMap.put(property.getName(), property);
if(property.isIdentity()) {
this.identifier = property;
}
else if(property.getName().equals( GrailsDomainClassProperty.VERSION )) {
this.version = property;
}
}
}
}
/**
* Retrieves the association map
*/
public Map getAssociationMap() {
if(this.relationshipMap == null) {
relationshipMap = (Map)getPropertyOrStaticPropertyOrFieldValue( GrailsDomainClassProperty.HAS_MANY, Map.class );
if(relationshipMap == null)
this.relationshipMap = new HashMap();
Class theClass = getClazz();
while(theClass != Object.class) {
theClass = theClass.getSuperclass();
Map superRelationshipMap = (Map)GrailsClassUtils.getStaticPropertyValue(theClass, GrailsDomainClassProperty.HAS_MANY);
if(superRelationshipMap != null && !superRelationshipMap.equals(relationshipMap)) {
relationshipMap.putAll(superRelationshipMap);
}
}
}
return this.relationshipMap;
}
/**
* Retrieves the list of known embedded component types
*
* @return A list of embedded components
*/
private Collection getEmbeddedList() {
Object potentialList = GrailsClassUtils.getStaticPropertyValue(getClazz(), GrailsDomainClassProperty.EMBEDDED);
if(potentialList instanceof Collection) {
return (Collection)potentialList;
}
return Collections.EMPTY_LIST;
}
/**
* Calculates the relationship type based other types referenced
*
*/
private void establishRelationships() {
for(Iterator i = this.propertyMap.values().iterator();i.hasNext(); ) {
DefaultGrailsDomainClassProperty currentProp = (DefaultGrailsDomainClassProperty)i.next();
Class currentPropType = currentProp.getType();
// establish if the property is a one-to-many
// if it is a Set and there are relationships defined
// and it is defined as persistent
if( Collection.class.isAssignableFrom(currentPropType) || Map.class.isAssignableFrom(currentPropType) &&
currentProp.isPersistent() ) {
establishRelationshipForCollection( currentProp);
}
// otherwise if the type is a domain class establish relationship
else if(DomainClassArtefactHandler.isDomainClass(currentPropType) &&
currentProp.isPersistent()) {
establishDomainClassRelationship( currentProp );
}
else if(!GrailsDomainConfigurationUtil.isBasicType(currentProp)) {
establishDomainClassRelationship( currentProp );
}
}
}
/**
* Establishes a relationship for a java.util.Set
*
* @param property The collection property
*/
private void establishRelationshipForCollection(DefaultGrailsDomainClassProperty property) {
// is it a relationship
Class relatedClassType = getRelatedClassType( property.getName() );
if(relatedClassType != null) {
// set the referenced type in the property
property.setReferencedPropertyType(relatedClassType);
// if the related type is a domain class
// then figure out what kind of relationship it is
if(DomainClassArtefactHandler.isDomainClass(relatedClassType)) {
// check the relationship defined in the referenced type
// if it is also a Set/domain class etc.
Map relatedClassRelationships = GrailsDomainConfigurationUtil.getAssociationMap(relatedClassType);
Class relatedClassPropertyType = null;
// First check whether there is an explicit relationship
// mapping for this property (as provided by "mappedBy").
String mappingProperty = (String)this.mappedBy.get(property.getName());
if(!StringUtils.isBlank(mappingProperty)) {
// First find the specified property on the related
// class, if it exists.
PropertyDescriptor pd = findProperty(GrailsClassUtils.getPropertiesOfType(relatedClassType, getClazz()), mappingProperty);
// If a property of the required type does not exist,
// search for any collection properties on the related
// class.
if(pd == null) pd = findProperty(GrailsClassUtils.getPropertiesAssignableToType(relatedClassType, Collection.class), mappingProperty);
// We've run out of options. The given "mappedBy"
// setting is invalid.
if(pd == null)
throw new GrailsDomainException("Non-existent mapping property ["+mappingProperty+"] specified for property ["+property.getName()+"] in class ["+getClazz()+"]");
// Tie the properties together.
relatedClassPropertyType = pd.getPropertyType();
property.setReferencePropertyName(pd.getName());
}
else {
// if the related type has a relationships map it may be a many-to-many
// figure out if there is a many-to-many relationship defined
if( isRelationshipManyToMany(property, relatedClassType, relatedClassRelationships)) {
String relatedClassPropertyName = null;
// retrieve the relationship property
for(Iterator i = relatedClassRelationships.keySet().iterator();i.hasNext();) {
String currentKey = (String)i.next();
Class currentClass = (Class) relatedClassRelationships.get( currentKey );
if(currentClass.isAssignableFrom(getClazz())) {
relatedClassPropertyName = currentKey;
break;
}
}
// if there is one defined get the type
if(relatedClassPropertyName != null) {
relatedClassPropertyType = GrailsClassUtils.getPropertyType( relatedClassType, relatedClassPropertyName);
}
}
// otherwise figure out if there is a one-to-many relationship by retrieving any properties that are of the related type
// if there is more than one property then (for the moment) ignore the relationship
if(relatedClassPropertyType == null) {
PropertyDescriptor[] descriptors = GrailsClassUtils.getPropertiesOfType(relatedClassType, getClazz());
if(descriptors.length == 1) {
relatedClassPropertyType = descriptors[0].getPropertyType();
property.setReferencePropertyName(descriptors[0].getName());
}
else if(descriptors.length > 1) {
// try now to use the class name by convention
String classPropertyName = getPropertyName();
PropertyDescriptor pd = findProperty(descriptors, classPropertyName);
if(pd == null) {
throw new GrailsDomainException("Property ["+property.getName()+"] in class ["+getClazz()+"] is a bidirectional one-to-many with two possible properties on the inverse side. "+
"Either name one of the properties on other side of the relationship ["+classPropertyName+"] or use the 'mappedBy' static to define the property " +
"that the relationship is mapped with. Example: static mappedBy = ["+property.getName()+":'myprop']");
}
relatedClassPropertyType = pd.getPropertyType();
property.setReferencePropertyName(pd.getName());
}
}
}
establishRelationshipForSetToType(property,relatedClassPropertyType);
// if its a many-to-many figure out the owning side of the relationship
if(property.isManyToMany()) {
establishOwnerOfManyToMany(property, relatedClassType);
}
}
// otherwise set it to not persistent as you can't persist
// relationships to non-domain classes
else {
property.setPersistant(false);
}
}
else if(!Map.class.isAssignableFrom(property.getType())) {
// no relationship defined for set.
// set not persistent
property.setPersistant(false);
}
}
/**
* Finds a property type is an array of descriptors for the given property name
*
* @param descriptors The descriptors
* @param propertyName The property name
* @return The Class or null
*/
private PropertyDescriptor findProperty(PropertyDescriptor[] descriptors, String propertyName) {
PropertyDescriptor d = null;
for (int i = 0; i < descriptors.length; i++) {
PropertyDescriptor descriptor = descriptors[i];
if(descriptor.getName().equals(propertyName)) {
d = descriptor;
break;
}
}
return d;
}
/**
* Find out if the relationship is a many-to-many
*
* @param property The property
* @param relatedClassType The related type
* @param relatedClassRelationships The related types relationships
* @return True if the relationship is a many-to-many
*/
private boolean isRelationshipManyToMany(DefaultGrailsDomainClassProperty property, Class relatedClassType, Map relatedClassRelationships) {
return relatedClassRelationships != null &&
!relatedClassRelationships.isEmpty() &&
!relatedClassType.equals(property.getDomainClass().getClazz());
}
/**
* Inspects a related classes' ownership settings against this properties class' ownership
* settings to find out who owns a many-to-many relationship
*
* @param property The property
* @param relatedClassType The related type
*/
private void establishOwnerOfManyToMany(DefaultGrailsDomainClassProperty property, Class relatedClassType) {
Object related = BeanUtils.instantiateClass(relatedClassType);
Object relatedBelongsTo = GrailsClassUtils.getPropertyOrStaticPropertyOrFieldValue(related, GrailsDomainClassProperty.BELONGS_TO);
boolean owningSide = false;
boolean relatedOwner = this.owners.contains(relatedClassType);
final Class propertyClass = property.getDomainClass().getClazz();
if(relatedBelongsTo instanceof Collection) {
owningSide = ((Collection)relatedBelongsTo).contains(propertyClass);
}
else if (relatedBelongsTo != null) {
owningSide = relatedBelongsTo.equals(propertyClass);
}
property.setOwningSide(owningSide);
if(relatedOwner && property.isOwningSide()) {
throw new GrailsDomainException("Domain classes ["+propertyClass+"] and ["+relatedClassType+"] cannot own each other in a many-to-many relationship. Both contain belongsTo definitions that reference each other.");
}
else if(!relatedOwner && !property.isOwningSide()) {
throw new GrailsDomainException("No owner defined between domain classes ["+propertyClass+"] and ["+relatedClassType+"] in a many-to-many relationship. Example: def belongsTo = "+relatedClassType.getName());
}
}
/**
* Establishes whether the relationship is a bi-directional or uni-directional one-to-many
* and applies the appropriate settings to the specified property
*
* @param property The property to apply settings to
* @param relatedClassPropertyType The related type
*/
private void establishRelationshipForSetToType(DefaultGrailsDomainClassProperty property, Class relatedClassPropertyType) {
if(relatedClassPropertyType == null) {
// uni-directional one-to-many
property.setOneToMany(true);
property.setBidirectional(false);
}
else if( Collection.class.isAssignableFrom(relatedClassPropertyType) ){
// many-to-many
property.setManyToMany(true);
property.setBidirectional(true);
}
else if(DomainClassArtefactHandler.isDomainClass(relatedClassPropertyType)) {
// bi-directional one-to-many
property.setOneToMany( true );
property.setBidirectional( true );
}
}
/**
* Establish relationship with related domain class
*
* @param property Establishes a relationship between this class and the domain class property
*/
private void establishDomainClassRelationship(DefaultGrailsDomainClassProperty property) {
Class propType = property.getType();
if(embedded.contains(property.getName())) {
property.setEmbedded(true);
return;
}
// establish relationship to type
Map relatedClassRelationships = GrailsDomainConfigurationUtil.getAssociationMap(propType);
Map mappedBy = GrailsDomainConfigurationUtil.getMappedByMap(propType);
Class relatedClassPropertyType = null;
// if there is a relationships map use that to find out
// whether it is mapped to a Set
if( relatedClassRelationships != null &&
!relatedClassRelationships.isEmpty() ) {
String relatedClassPropertyName = findOneToManyThatMatchesType(property, relatedClassRelationships);
PropertyDescriptor[] descriptors = GrailsClassUtils.getPropertiesOfType(getClazz(), property.getType());
// if there is only one property on many-to-one side of the relationship then
// try to establish if it is bidirectional
if(descriptors.length == 1 && isNotMappedToDifferentProperty(property,relatedClassPropertyName, mappedBy)) {
if(!StringUtils.isBlank(relatedClassPropertyName)) {
property.setReferencePropertyName(relatedClassPropertyName);
// get the type of the property
relatedClassPropertyType = GrailsClassUtils.getPropertyType( propType, relatedClassPropertyName );
}
}
// if there is more than one property on the many-to-one side then we need to either
// find out if there is a mappedBy property or whether a convention is used to decide
// on the mapping property
else if(descriptors.length > 1) {
if(mappedBy.containsValue(property.getName())) {
for (Iterator i = mappedBy.keySet().iterator(); i.hasNext();) {
String mappedByPropertyName = (String) i.next();
if(property.getName().equals(mappedBy.get(mappedByPropertyName))) {
Class mappedByRelatedType = (Class)relatedClassRelationships.get(mappedByPropertyName);
if(mappedByRelatedType != null && propType.isAssignableFrom(mappedByRelatedType))
relatedClassPropertyType = GrailsClassUtils.getPropertyType( propType, mappedByPropertyName );
}
}
}
else {
String classNameAsProperty = GrailsClassUtils.getPropertyName(propType);
if(property.getName().equals(classNameAsProperty) && !mappedBy.containsKey(relatedClassPropertyName)) {
relatedClassPropertyType = GrailsClassUtils.getPropertyType( propType, relatedClassPropertyName );
}
}
}
}
// otherwise retrieve all the properties of the type from the associated class
if(relatedClassPropertyType == null) {
PropertyDescriptor[] descriptors = GrailsClassUtils.getPropertiesOfType(propType, getClazz());
// if there is only one then the association is established
if(descriptors.length == 1) {
relatedClassPropertyType = descriptors[0].getPropertyType();
}
}
// establish relationship based on this type
establishDomainClassRelationshipToType( property, relatedClassPropertyType );
}
private boolean isNotMappedToDifferentProperty(GrailsDomainClassProperty property, String relatedClassPropertyName, Map mappedBy) {
String mappedByForRelation = (String)mappedBy.get(relatedClassPropertyName);
if(mappedByForRelation == null) return true;
else if(!property.getName().equals(mappedByForRelation)) return false;
return true;
}
private String findOneToManyThatMatchesType(DefaultGrailsDomainClassProperty property, Map relatedClassRelationships) {
String relatedClassPropertyName = null;
for(Iterator i = relatedClassRelationships.keySet().iterator();i.hasNext();) {
String currentKey = (String)i.next();
Class currentClass = (Class)relatedClassRelationships.get( currentKey );
if(property.getDomainClass().getClazz().getName().equals( currentClass.getName() )) {
relatedClassPropertyName = currentKey;
break;
}
}
return relatedClassPropertyName;
}
private void establishDomainClassRelationshipToType(DefaultGrailsDomainClassProperty property, Class relatedClassPropertyType) {
// uni-directional one-to-one
if(relatedClassPropertyType == null) {
property.setOneToOne(true);
property.setBidirectional(false);
}
// bi-directional many-to-one
else if(Collection.class.isAssignableFrom(relatedClassPropertyType)||Map.class.isAssignableFrom(relatedClassPropertyType)) {
property.setManyToOne(true);
property.setBidirectional(true);
}
// bi-directional one-to-one
else if(DomainClassArtefactHandler.isDomainClass(relatedClassPropertyType)) {
property.setOneToOne(true);
if(!getClazz().equals(relatedClassPropertyType))
property.setBidirectional(true);
}
}
public boolean isOwningClass(Class domainClass) {
return this.owners.contains(domainClass);
}
/* (non-Javadoc)
* @see org.codehaus.groovy.grails.domain.GrailsDomainClass#getProperties()
*/
public GrailsDomainClassProperty[] getProperties() {
return this.properties;
}
/* (non-Javadoc)
* @see org.codehaus.groovy.grails.domain.GrailsDomainClass#getIdentifier()
*/
public GrailsDomainClassProperty getIdentifier() {
return this.identifier;
}
/* (non-Javadoc)
* @see org.codehaus.groovy.grails.domain.GrailsDomainClass#getVersion()
*/
public GrailsDomainClassProperty getVersion() {
return this.version;
}
/**
* @see org.codehaus.groovy.grails.commons.GrailsDomainClass#getPersistantProperties()
* @deprecated
*/
public GrailsDomainClassProperty[] getPersistantProperties() {
return this.persistentProperties;
}
public GrailsDomainClassProperty[] getPersistentProperties() {
return this.persistentProperties;
}
/* (non-Javadoc)
* @see org.codehaus.groovy.grails.domain.GrailsDomainClass#getPropertyByName(java.lang.String)
*/
public GrailsDomainClassProperty getPropertyByName(String name) {
if(this.propertyMap.containsKey(name)) {
return (GrailsDomainClassProperty)this.propertyMap.get(name);
}
else {
throw new InvalidPropertyException("No property found for name ["+name+"] for class ["+getClazz()+"]");
}
}
/* (non-Javadoc)
* @see org.codehaus.groovy.grails.domain.GrailsDomainClass#getFieldName(java.lang.String)
*/
public String getFieldName(String propertyName) {
return getPropertyByName(propertyName).getFieldName();
}
/* (non-Javadoc)
* @see org.codehaus.groovy.grails.commons.AbstractGrailsClass#getName()
*/
public String getName() {
return ClassUtils.getShortClassName(super.getName());
}
/* (non-Javadoc)
* @see org.codehaus.groovy.grails.domain.GrailsDomainClass#isOneToMany(java.lang.String)
*/
public boolean isOneToMany(String propertyName) {
return getPropertyByName(propertyName).isOneToMany();
}
/* (non-Javadoc)
* @see org.codehaus.groovy.grails.domain.GrailsDomainClass#isManyToOne(java.lang.String)
*/
public boolean isManyToOne(String propertyName) {
return getPropertyByName(propertyName).isManyToOne();
}
protected Object getPropertyOrStaticPropertyOrFieldValue(String name, Class type) {
return super.getPropertyOrStaticPropertyOrFieldValue(name,type);
}
/* (non-Javadoc)
* @see org.codehaus.groovy.grails.commons.GrailsDomainClass#getRelationshipType(java.lang.String)
*/
public Class getRelatedClassType(String propertyName) {
return (Class)this.relationshipMap.get(propertyName);
}
/* (non-Javadoc)
* @see org.codehaus.groovy.grails.commons.GrailsDomainClass#getPropertyName()
*/
public String getPropertyName() {
return GrailsClassUtils.getPropertyNameRepresentation(getClazz());
}
/* (non-Javadoc)
* @see org.codehaus.groovy.grails.commons.GrailsDomainClass#isBidirectional()
*/
public boolean isBidirectional(String propertyName) {
return getPropertyByName(propertyName).isBidirectional();
}
/* (non-Javadoc)
* @see org.codehaus.groovy.grails.commons.GrailsDomainClass#getConstraints()
*/
public Map getConstrainedProperties() {
return Collections.unmodifiableMap(this.constraints);
}
/* (non-Javadoc)
* @see org.codehaus.groovy.grails.commons.GrailsDomainClass#getValidator()
*/
public Validator getValidator() {
return this.validator;
}
/* (non-Javadoc)
* @see org.codehaus.groovy.grails.commons.GrailsDomainClass#setValidator(Validator validator)
*/
public void setValidator(Validator validator) {
this.validator = validator;
}
/* (non-Javadoc)
* @see org.codehaus.groovy.grails.commons.GrailsDomainClass#getMappedBy()
*/
public String getMappingStrategy() {
return this.mappingStrategy;
}
public boolean isRoot() {
return this.root;
}
public Set getSubClasses() {
return this.subClasses;
}
public void refreshConstraints() {
try {
this.constraints = GrailsDomainConfigurationUtil.evaluateConstraints(getReference().getWrappedInstance(), this.persistentProperties);
// Embedded components have their own ComponentDomainClass
// instance which won't be refreshed by the application.
// So, we have to do it here.
for (int i = 0; i < this.persistentProperties.length; i++) {
GrailsDomainClassProperty property = this.persistentProperties[i];
if (property.isEmbedded()) {
property.getComponent().refreshConstraints();
}
}
} catch (IntrospectionException e) {
LOG.error("Error reading class ["+getClazz()+"] constraints: " +e .getMessage(), e);
}
}
public Map getMappedBy() {
return mappedBy;
}
public boolean hasPersistentProperty(String propertyName) {
for (int i = 0; i < persistentProperties.length; i++) {
GrailsDomainClassProperty persistentProperty = persistentProperties[i];
if(persistentProperty.getName().equals(propertyName)) return true;
}
return false;
}
public void setMappingStrategy(String strategy) {
this.mappingStrategy = strategy;
}
}
The table below shows all metrics for DefaultGrailsDomainClass.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 114.00 | Number of blocks | |
| BLOCK_COMMENT | 59.00 | Number of block comment lines | |
| COMMENTS | 194.00 | Comment lines | |
| COMMENT_DENSITY | 0.60 | Comment density | |
| COMPARISONS | 101.00 | Number of comparison operators | |
| CYCLOMATIC | 133.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 30.00 | Comments in declarations | |
| DOC_COMMENT | 70.00 | Number of javadoc comment lines | |
| ELOC | 323.00 | Effective lines of code | |
| EXEC_COMMENTS | 45.00 | Comments in executable code | |
| EXITS | 108.00 | Procedure exits | |
| FUNCTIONS | 42.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 80.91 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 89.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 10.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 5.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 0.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 1.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 1.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 0.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 0.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 0.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 1.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 0.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 2.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 0.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 1.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 5.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 1.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 0.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 19.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 152.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 0.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 0.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 0.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 1.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 5.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 4.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 3.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 0.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 729.00 | Number of lines in the source file | |
| LINE_COMMENT | 65.00 | Number of line comments | |
| LOC | 436.00 | Lines of code | |
| LOGICAL_LINES | 212.00 | Number of statements | |
| LOOPS | 10.00 | Number of loops | |
| NEST_DEPTH | 7.00 | Maximum nesting depth | |
| OPERANDS | 1070.00 | Number of operands | |
| OPERATORS | 2257.00 | Number of operators | |
| PARAMS | 32.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 3327.00 | Halstead program length | |
| PROGRAM_VOCAB | 373.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 57.00 | Number of return points from functions | |
| SIZE | 31159.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 324.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 49.00 | Number of unique operators | |
| WHITESPACE | 99.00 | Number of whitespace lines | |