All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.ebeaninternal.server.deploy.meta.DeployBeanPropertyLists Maven / Gradle / Ivy

There is a newer version: 15.8.1
Show newest version
package io.ebeaninternal.server.deploy.meta;

import io.ebean.bean.BeanCollection.ModifyListenMode;
import io.ebeaninternal.server.deploy.BeanDescriptor;
import io.ebeaninternal.server.deploy.BeanDescriptorMap;
import io.ebeaninternal.server.deploy.BeanProperty;
import io.ebeaninternal.server.deploy.BeanPropertyAssocMany;
import io.ebeaninternal.server.deploy.BeanPropertyAssocOne;
import io.ebeaninternal.server.deploy.BeanPropertySimpleCollection;
import io.ebeaninternal.server.deploy.InheritInfo;
import io.ebeaninternal.server.deploy.TableJoin;
import io.ebeaninternal.server.type.ScalarTypeString;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;

/**
 * Helper object to classify BeanProperties into appropriate lists.
 */
public class DeployBeanPropertyLists {

  private static final Logger logger = LoggerFactory.getLogger(DeployBeanPropertyLists.class);

  private BeanProperty versionProperty;

  private BeanProperty unmappedJson;

  private BeanProperty draft;

  private BeanProperty draftDirty;

  private BeanProperty tenant;

  private final BeanDescriptor desc;

  private final LinkedHashMap propertyMap;

  private final List ids = new ArrayList<>();

  private final List local = new ArrayList<>();

  private final List mutable = new ArrayList<>();

  private final List> manys = new ArrayList<>();

  private final List nonManys = new ArrayList<>();

  private final List> ones = new ArrayList<>();

  private final List> onesImported = new ArrayList<>();

  private final List> embedded = new ArrayList<>();

  private final List baseScalar = new ArrayList<>();

  private final List transients = new ArrayList<>();

  private final List nonTransients = new ArrayList<>();

  private final TableJoin[] tableJoins;

  private final BeanPropertyAssocOne unidirectional;

  @SuppressWarnings({"unchecked", "rawtypes"})
  public DeployBeanPropertyLists(BeanDescriptorMap owner, BeanDescriptor desc, DeployBeanDescriptor deploy) {
    this.desc = desc;

    setImportedPrimaryKeys(deploy);

    DeployBeanPropertyAssocOne deployUnidirectional = deploy.getUnidirectional();
    if (deployUnidirectional == null) {
      unidirectional = null;
    } else {
      unidirectional = new BeanPropertyAssocOne(owner, desc, deployUnidirectional);
    }

    this.propertyMap = new LinkedHashMap<>();

    // see if there is a discriminator property we should add
    String discriminatorColumn = null;
    BeanProperty discProperty = null;

    InheritInfo inheritInfo = deploy.getInheritInfo();
    if (inheritInfo != null) {
      // Create a BeanProperty for the discriminator column to support
      // using RawSql queries with inheritance
      discriminatorColumn = inheritInfo.getDiscriminatorColumn();
      DeployBeanProperty discDeployProp = new DeployBeanProperty(deploy, String.class, new ScalarTypeString(), null);
      discDeployProp.setDiscriminator();
      discDeployProp.setName(discriminatorColumn);
      discDeployProp.setDbColumn(discriminatorColumn);

      // only register it in the propertyMap. This might not be used if
      // an explicit property is mapped to the discriminator on the bean
      discProperty = new BeanProperty(desc, discDeployProp);
    }

    for (DeployBeanProperty prop : deploy.propertiesAll()) {
      if (discriminatorColumn != null && discriminatorColumn.equals(prop.getDbColumn())) {
        // we have an explicit property mapped to the discriminator column
        prop.setDiscriminator();
        discProperty = null;
      }
      BeanProperty beanProp = createBeanProperty(owner, prop);
      propertyMap.put(beanProp.getName(), beanProp);
    }

    int order = 0;
    for (BeanProperty prop : propertyMap.values()) {
      prop.setDeployOrder(order++);
      allocateToList(prop);
    }

    if (discProperty != null) {
      // put the discriminator property into the property map only
      // (after the real properties have been organised into their lists)
      propertyMap.put(discProperty.getName(), discProperty);
    }

    List deployTableJoins = deploy.getTableJoins();
    tableJoins = new TableJoin[deployTableJoins.size()];
    for (int i = 0; i < deployTableJoins.size(); i++) {
      tableJoins[i] = new TableJoin(deployTableJoins.get(i));
    }
  }

  /**
   * Find and set imported primary keys.
   * 

* This is where @ManyToOne properties maps to a PFK (Primary and foreign key). * Perform the match by naming convention on property name and db column. *

*/ private void setImportedPrimaryKeys(DeployBeanDescriptor deploy) { List ids = deploy.propertiesId(); if (ids.size() == 1) { DeployBeanProperty id = ids.get(0); if (id instanceof DeployBeanPropertyAssocOne) { // only interested if the primary key is a compound key DeployBeanDescriptor targetDeploy = ((DeployBeanPropertyAssocOne) id).getTargetDeploy(); for (DeployBeanPropertyAssocOne assoc : deploy.propertiesAssocOne()) { DeployBeanProperty pkMatch = targetDeploy.findMatch(assoc.getName(), assoc.getDbColumn()); if (pkMatch != null) { assoc.setImportedPrimaryKey(pkMatch); } } } } } /** * Return the unidirectional. */ public BeanPropertyAssocOne getUnidirectional() { return unidirectional; } /** * Allocate the property to a list. */ private void allocateToList(BeanProperty prop) { if (prop.isTransient()) { transients.add(prop); if (prop.isDraft()) { draft = prop; } if (prop.isUnmappedJson()) { unmappedJson = prop; } return; } if (prop.isId()) { ids.add(prop); return; } else { nonTransients.add(prop); } if (prop.isMutableScalarType()) { mutable.add(prop); } if (desc.getInheritInfo() != null && prop.isLocal()) { local.add(prop); } if (prop instanceof BeanPropertyAssocMany) { manys.add((BeanPropertyAssocMany) prop); } else { nonManys.add(prop); if (prop instanceof BeanPropertyAssocOne) { BeanPropertyAssocOne assocOne = (BeanPropertyAssocOne) prop; if (prop.isEmbedded()) { embedded.add(assocOne); } else { ones.add(assocOne); if (!assocOne.isOneToOneExported()) { onesImported.add(assocOne); } } } else { // its a "base" property... if (prop.isVersion()) { if (versionProperty == null) { versionProperty = prop; } else { logger.warn("Multiple @Version properties - property " + prop.getFullBeanName() + " not treated as a version property"); } } else if (prop.isDraftDirty()) { draftDirty = prop; } else if (prop.isTenantId()) { tenant = prop; } if (!prop.isAggregation()) { baseScalar.add(prop); } } } } public LinkedHashMap getPropertyMap() { return propertyMap; } public TableJoin[] getTableJoin() { return tableJoins; } /** * Return the base scalar properties (excludes Id and secondary table * properties). */ public BeanProperty[] getBaseScalar() { return baseScalar.toArray(new BeanProperty[baseScalar.size()]); } public BeanProperty getId() { if (ids.size() > 1) { String msg = "Issue with bean " + desc + ". Ebean does not support multiple @Id properties. You need to convert to using an @EmbeddedId." + " Please email the ebean google group if you need further clarification."; throw new IllegalStateException(msg); } if (ids.isEmpty()) { return null; } return ids.get(0); } public BeanProperty[] getNonTransients() { return nonTransients.toArray(new BeanProperty[nonTransients.size()]); } public BeanProperty[] getTransients() { return transients.toArray(new BeanProperty[transients.size()]); } public BeanProperty getVersionProperty() { return versionProperty; } public BeanProperty[] getLocal() { return local.toArray(new BeanProperty[local.size()]); } public BeanProperty[] getMutable() { return mutable.toArray(new BeanProperty[mutable.size()]); } public BeanPropertyAssocOne[] getEmbedded() { return embedded.toArray(new BeanPropertyAssocOne[embedded.size()]); } public BeanPropertyAssocOne[] getOneImported() { return onesImported.toArray(new BeanPropertyAssocOne[onesImported.size()]); } public BeanPropertyAssocOne[] getOnes() { return ones.toArray(new BeanPropertyAssocOne[ones.size()]); } public BeanPropertyAssocOne[] getOneExportedSave() { return getOne(false, Mode.Save); } public BeanPropertyAssocOne[] getOneExportedDelete() { return getOne(false, Mode.Delete); } public BeanPropertyAssocOne[] getOneImportedSave() { return getOne(true, Mode.Save); } public BeanPropertyAssocOne[] getOneImportedDelete() { return getOne(true, Mode.Delete); } public BeanProperty[] getNonMany() { return nonManys.toArray(new BeanProperty[nonManys.size()]); } public BeanPropertyAssocMany[] getMany() { return manys.toArray(new BeanPropertyAssocMany[manys.size()]); } public BeanPropertyAssocMany[] getManySave() { return getMany(Mode.Save); } public BeanPropertyAssocMany[] getManyDelete() { return getMany(Mode.Delete); } public BeanPropertyAssocMany[] getManyToMany() { return getMany2Many(); } public BeanProperty getDraftDirty() { return draftDirty; } public BeanProperty getUnmappedJson() { return unmappedJson; } public BeanProperty getDraft() { return draft; } public BeanProperty getSoftDeleteProperty() { for (BeanProperty prop : nonManys) { if (prop.isSoftDelete()) { return prop; } } return null; } public BeanProperty getTenant() { return tenant; } /** * Mode used to determine which BeanPropertyAssoc to include. */ private enum Mode { Save, Delete } private BeanPropertyAssocOne[] getOne(boolean imported, Mode mode) { ArrayList> list = new ArrayList<>(); for (BeanPropertyAssocOne prop : ones) { if (imported != prop.isOneToOneExported()) { switch (mode) { case Save: if (prop.getCascadeInfo().isSave()) { list.add(prop); } break; case Delete: if (prop.getCascadeInfo().isDelete()) { list.add(prop); } break; default: break; } } } return (BeanPropertyAssocOne[]) list.toArray(new BeanPropertyAssocOne[list.size()]); } private BeanPropertyAssocMany[] getMany2Many() { ArrayList> list = new ArrayList<>(); for (BeanPropertyAssocMany prop : manys) { if (prop.isManyToMany()) { list.add(prop); } } return (BeanPropertyAssocMany[]) list.toArray(new BeanPropertyAssocMany[list.size()]); } private BeanPropertyAssocMany[] getMany(Mode mode) { ArrayList> list = new ArrayList<>(); for (BeanPropertyAssocMany prop : manys) { switch (mode) { case Save: if (prop.getCascadeInfo().isSave() || prop.isManyToMany() || ModifyListenMode.REMOVALS.equals(prop.getModifyListenMode())) { // Note ManyToMany always included as we always 'save' // the relationship via insert/delete of intersection table // REMOVALS means including PrivateOwned relationships list.add(prop); } break; case Delete: if (prop.getCascadeInfo().isDelete() || ModifyListenMode.REMOVALS.equals(prop.getModifyListenMode())) { // REMOVALS means including PrivateOwned relationships list.add(prop); } break; default: break; } } return (BeanPropertyAssocMany[]) list.toArray(new BeanPropertyAssocMany[list.size()]); } @SuppressWarnings({"unchecked", "rawtypes"}) private BeanProperty createBeanProperty(BeanDescriptorMap owner, DeployBeanProperty deployProp) { if (deployProp instanceof DeployBeanPropertyAssocOne) { return new BeanPropertyAssocOne(owner, desc, (DeployBeanPropertyAssocOne) deployProp); } if (deployProp instanceof DeployBeanPropertySimpleCollection) { return new BeanPropertySimpleCollection(desc, (DeployBeanPropertySimpleCollection) deployProp); } if (deployProp instanceof DeployBeanPropertyAssocMany) { return new BeanPropertyAssocMany(desc, (DeployBeanPropertyAssocMany) deployProp); } return new BeanProperty(desc, deployProp); } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy