Package org.hibernate.persister.entity

Source Code of org.hibernate.persister.entity.AbstractPropertyMapping

/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2008, Red Hat Middleware LLC or third-party contributors as
* indicated by the @author tags or express copyright attribution
* statements applied by the authors.  All third-party contributions are
* distributed under license by Red Hat Middleware LLC.
*
* This copyrighted material is made available to anyone wishing to use, modify,
* copy, or redistribute it subject to the terms and conditions of the GNU
* Lesser General Public License, as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this distribution; if not, write to:
* Free Software Foundation, Inc.
* 51 Franklin Street, Fifth Floor
* Boston, MA  02110-1301  USA
*
*/
package org.hibernate.persister.entity;

import java.util.HashMap;
import java.util.Map;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.hibernate.MappingException;
import org.hibernate.QueryException;
import org.hibernate.engine.Mapping;
import org.hibernate.sql.Template;
import org.hibernate.type.AbstractComponentType;
import org.hibernate.type.AssociationType;
import org.hibernate.type.EntityType;
import org.hibernate.type.Type;
import org.hibernate.util.ArrayHelper;
import org.hibernate.util.StringHelper;

/**
* Basic implementation of the {@link PropertyMapping} contract.
*
* @author Gavin King
*/
public abstract class AbstractPropertyMapping implements PropertyMapping {
  private static final Logger log = LoggerFactory.getLogger( AbstractPropertyMapping.class );

  private final Map typesByPropertyPath = new HashMap();
  private final Map columnsByPropertyPath = new HashMap();
  private final Map columnReadersByPropertyPath = new HashMap();
  private final Map columnReaderTemplatesByPropertyPath = new HashMap();
  private final Map formulaTemplatesByPropertyPath = new HashMap();

  public String[] getIdentifierColumnNames() {
    throw new UnsupportedOperationException("one-to-one is not supported here");
  }

  public String[] getIdentifierColumnReaderTemplates() {
    throw new UnsupportedOperationException("one-to-one is not supported here");
  }

  public String[] getIdentifierColumnReaders() {
    throw new UnsupportedOperationException("one-to-one is not supported here");
  }
 
  protected abstract String getEntityName();

  public Type toType(String propertyName) throws QueryException {
    Type type = (Type) typesByPropertyPath.get(propertyName);
    if ( type == null ) {
      throw propertyException( propertyName );
    }
    return type;
  }

  protected final QueryException propertyException(String propertyName) throws QueryException {
    return new QueryException( "could not resolve property: " + propertyName + " of: " + getEntityName() );
  }

  public String[] getColumnNames(String propertyName) {
    String[] cols = (String[]) columnsByPropertyPath.get(propertyName);
    if (cols==null) {
      throw new MappingException("unknown property: " + propertyName);
    }
    return cols;
  }

  public String[] toColumns(String alias, String propertyName) throws QueryException {
    //TODO: *two* hashmap lookups here is one too many...
    String[] columns = (String[]) columnsByPropertyPath.get(propertyName);
    if ( columns == null ) {
      throw propertyException( propertyName );
    }
    String[] formulaTemplates = (String[]) formulaTemplatesByPropertyPath.get(propertyName);
    String[] columnReaderTemplates = (String[]) columnReaderTemplatesByPropertyPath.get(propertyName);   
    String[] result = new String[columns.length];
    for ( int i=0; i<columns.length; i++ ) {
      if ( columnReaderTemplates[i]==null ) {
        result[i] = StringHelper.replace( formulaTemplates[i], Template.TEMPLATE, alias );
      }
      else {
        result[i] = StringHelper.replace( columnReaderTemplates[i], Template.TEMPLATE, alias );
      }
    }
    return result;
  }

  public String[] toColumns(String propertyName) throws QueryException {
    String[] columns = (String[]) columnsByPropertyPath.get(propertyName);
    if ( columns == null ) {
      throw propertyException( propertyName );
    }
    String[] formulaTemplates = (String[]) formulaTemplatesByPropertyPath.get(propertyName);
    String[] columnReaders = (String[]) columnReadersByPropertyPath.get(propertyName);
    String[] result = new String[columns.length];
    for ( int i=0; i<columns.length; i++ ) {
      if ( columnReaders[i]==null ) {
        result[i] = StringHelper.replace( formulaTemplates[i], Template.TEMPLATE, "" );
      }
      else {
        result[i] = columnReaders[i];
      }
    }
    return result;
  }

  protected void addPropertyPath(
      String path,
      Type type,
      String[] columns,
      String[] columnReaders,
      String[] columnReaderTemplates,
      String[] formulaTemplates) {
    // TODO : not quite sure yet of the difference, but this is only needed from annotations for @Id @ManyToOne support
    if ( typesByPropertyPath.containsKey( path ) ) {
      if ( log.isTraceEnabled() ) {
        log.trace(
            "Skipping duplicate registration of path [" + path
                + "], existing type = [" + typesByPropertyPath.get(path)
                + "], incoming type = [" + type + "]"
        );
      }
      return;
    }
    typesByPropertyPath.put(path, type);
    columnsByPropertyPath.put(path, columns);
    columnReadersByPropertyPath.put(path, columnReaders);
    columnReaderTemplatesByPropertyPath.put(path, columnReaderTemplates);
    if (formulaTemplates!=null) {
      formulaTemplatesByPropertyPath.put(path, formulaTemplates);
    }
  }

  /*protected void initPropertyPaths(
      final String path,
      final Type type,
      final String[] columns,
      final String[] formulaTemplates,
      final Mapping factory)
  throws MappingException {
    //addFormulaPropertyPath(path, type, formulaTemplates);
    initPropertyPaths(path, type, columns, formulaTemplates, factory);
  }*/

  protected void initPropertyPaths(
      final String path,
      final Type type,
      String[] columns,
      String[] columnReaders,
      String[] columnReaderTemplates,
      final String[] formulaTemplates,
      final Mapping factory)
  throws MappingException {

    if ( columns.length!=type.getColumnSpan(factory) ) {
      throw new MappingException(
          "broken column mapping for: " + path +
          " of: " + getEntityName()
        );
    }

    if ( type.isAssociationType() ) {
      AssociationType actype = (AssociationType) type;
      if ( actype.useLHSPrimaryKey() ) {
        columns = getIdentifierColumnNames();
        columnReaders = getIdentifierColumnReaders();
        columnReaderTemplates = getIdentifierColumnReaderTemplates();
      }
      else {
        String foreignKeyProperty = actype.getLHSPropertyName();
        if ( foreignKeyProperty!=null && !path.equals(foreignKeyProperty) ) {
          //TODO: this requires that the collection is defined after the
          //      referenced property in the mapping file (ok?)
          columns = (String[]) columnsByPropertyPath.get(foreignKeyProperty);
          if (columns==null) return; //get em on the second pass!
          columnReaders = (String[]) columnReadersByPropertyPath.get(foreignKeyProperty);
          columnReaderTemplates = (String[]) columnReaderTemplatesByPropertyPath.get(foreignKeyProperty);
        }
      }
    }

    if (path!=null) addPropertyPath(path, type, columns, columnReaders, columnReaderTemplates, formulaTemplates);

    if ( type.isComponentType() ) {
      AbstractComponentType actype = (AbstractComponentType) type;
      initComponentPropertyPaths( path, actype, columns, columnReaders, columnReaderTemplates, formulaTemplates, factory );
      if ( actype.isEmbedded() ) {
        initComponentPropertyPaths(
            path==null ? null : StringHelper.qualifier(path),
            actype,
            columns,
            columnReaders,
            columnReaderTemplates,
            formulaTemplates,
            factory
          );
      }
    }
    else if ( type.isEntityType() ) {
      initIdentifierPropertyPaths( path, (EntityType) type, columns, columnReaders, columnReaderTemplates, factory );
    }
  }

  protected void initIdentifierPropertyPaths(
      final String path,
      final EntityType etype,
      final String[] columns,
      final String[] columnReaders,
      final String[] columnReaderTemplates,
      final Mapping factory) throws MappingException {

    Type idtype = etype.getIdentifierOrUniqueKeyType( factory );
    String idPropName = etype.getIdentifierOrUniqueKeyPropertyName(factory);
    boolean hasNonIdentifierPropertyNamedId = hasNonIdentifierPropertyNamedId( etype, factory );

    if ( etype.isReferenceToPrimaryKey() ) {
      if ( !hasNonIdentifierPropertyNamedId ) {
        String idpath1 = extendPath(path, EntityPersister.ENTITY_ID);
        addPropertyPath(idpath1, idtype, columns, columnReaders, columnReaderTemplates, null);
        initPropertyPaths(idpath1, idtype, columns, columnReaders, columnReaderTemplates, null, factory);
      }
    }

    if (idPropName!=null) {
      String idpath2 = extendPath(path, idPropName);
      addPropertyPath(idpath2, idtype, columns, columnReaders, columnReaderTemplates, null);
      initPropertyPaths(idpath2, idtype, columns, columnReaders, columnReaderTemplates, null, factory);
    }
  }

  private boolean hasNonIdentifierPropertyNamedId(final EntityType entityType, final Mapping factory) {
    // TODO : would be great to have a Mapping#hasNonIdentifierPropertyNamedId method
    // I don't believe that Mapping#getReferencedPropertyType accounts for the identifier property; so
    // if it returns for a property named 'id', then we should have a non-id field named id
    try {
      return factory.getReferencedPropertyType( entityType.getAssociatedEntityName(), EntityPersister.ENTITY_ID ) != null;
    }
    catch( MappingException e ) {
      return false;
    }
  }

  protected void initComponentPropertyPaths(
      final String path,
      final AbstractComponentType type,
      final String[] columns,
      final String[] columnReaders,
      final String[] columnReaderTemplates,
      String[] formulaTemplates, final Mapping factory)
  throws MappingException {

    Type[] types = type.getSubtypes();
    String[] properties = type.getPropertyNames();
    int begin=0;
    for ( int i=0; i<properties.length; i++ ) {
      String subpath = extendPath( path, properties[i] );
      try {
        int length = types[i].getColumnSpan(factory);
        String[] columnSlice = ArrayHelper.slice(columns, begin, length);
        String[] columnReaderSlice = ArrayHelper.slice(columnReaders, begin, length);
        String[] columnReaderTemplateSlice = ArrayHelper.slice(columnReaderTemplates, begin, length);
        String[] formulaSlice = formulaTemplates==null ?
            null : ArrayHelper.slice(formulaTemplates, begin, length);
        initPropertyPaths(subpath, types[i], columnSlice, columnReaderSlice, columnReaderTemplateSlice, formulaSlice, factory);
        begin+=length;
      }
      catch (Exception e) {
        throw new MappingException("bug in initComponentPropertyPaths", e);
      }
    }
  }

  private static String extendPath(String path, String property) {
    if ( path==null || "".equals(path) ) {
      return property;
    }
    else {
      return StringHelper.qualify(path, property);
    }
  }

}
TOP

Related Classes of org.hibernate.persister.entity.AbstractPropertyMapping

TOP
Copyright © 2018 www.massapi.com. All rights reserved.
All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.