/*******************************************************************************
* Copyright (c) 1998, 2015 Oracle and/or its affiliates. All rights reserved.
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
* which accompanies this distribution.
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
* and the Eclipse Distribution License is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* Contributors:
* Oracle - initial API and implementation from Oracle TopLink
* 05/16/2008-1.0M8 Guy Pelletier
* - 218084: Implement metadata merging functionality between mapping file
* 09/23/2008-1.1 Guy Pelletier
* - 241651: JPA 2.0 Access Type support
* 10/01/2008-1.1 Guy Pelletier
* - 249329: To remain JPA 1.0 compliant, any new JPA 2.0 annotations should be referenced by name
* 04/09/2010-2.1 Guy Pelletier
* - 307050: Add defaults for access methods of a VIRTUAL access type
* 04/27/2010-2.1 Guy Pelletier
* - 309856: MappedSuperclasses from XML are not being initialized properly
* 12/01/2010-2.2 Guy Pelletier
* - 331234: xml-mapping-metadata-complete overriden by metadata-complete specification
* 03/24/2011-2.3 Guy Pelletier
* - 337323: Multi-tenant with shared schema support (part 1)
* 07/03/2011-2.3.1 Guy Pelletier
* - 348756: m_cascadeOnDelete boolean should be changed to Boolean
******************************************************************************/
package org.eclipse.persistence.internal.jpa.metadata.xml;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.persistence.internal.jpa.metadata.ORMetadata;
import org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject;
import org.eclipse.persistence.internal.jpa.metadata.columns.TenantDiscriminatorColumnMetadata;
import org.eclipse.persistence.internal.jpa.metadata.listeners.EntityListenerMetadata;
import org.eclipse.persistence.internal.jpa.metadata.mappings.AccessMethodsMetadata;
/**
* Object to hold onto the XML persistence unit defaults.
*
* Key notes:
* - any metadata mapped from XML to this class must be compared in the
* equals method.
* - when loading from annotations, the constructor accepts the metadata
* accessor this metadata was loaded from. Used it to look up any
* 'companion' annotation needed for processing.
* - methods should be preserved in alphabetical order.
*
* @author Guy Pelletier
* @since EclipseLink 1.0
*/
public class XMLPersistenceUnitDefaults extends ORMetadata {
private AccessMethodsMetadata m_accessMethods;
private Boolean m_cascadePersist;
private Boolean m_delimitedIdentifiers;
private List<EntityListenerMetadata> m_entityListeners = new ArrayList<EntityListenerMetadata>();
private List<TenantDiscriminatorColumnMetadata> m_tenantDiscriminatorColumns = new ArrayList<TenantDiscriminatorColumnMetadata>();
private String m_access;
private String m_catalog;
private String m_schema;
/**
* INTERNAL:
*/
public XMLPersistenceUnitDefaults() {
super("<persistence-unit-defaults>");
}
/**
* INTERNAL:
*/
public boolean equals(Object objectToCompare) {
if (objectToCompare instanceof XMLPersistenceUnitDefaults) {
XMLPersistenceUnitDefaults persistenceUnitDefaults = (XMLPersistenceUnitDefaults) objectToCompare;
if (! valuesMatch(persistenceUnitDefaults.getAccess(), getAccess())) {
return false;
}
if (! valuesMatch(persistenceUnitDefaults.getCatalog(), getCatalog())) {
return false;
}
if (! valuesMatch(persistenceUnitDefaults.getSchema(), getSchema())) {
return false;
}
if (! valuesMatch(persistenceUnitDefaults.getCascadePersist(), getCascadePersist())) {
return false;
}
if (! valuesMatch(persistenceUnitDefaults.getDelimitedIdentifiers(), getDelimitedIdentifiers())) {
return false;
}
if (! valuesMatch(persistenceUnitDefaults.getAccessMethods(), getAccessMethods())) {
return false;
}
if (! valuesMatch(persistenceUnitDefaults.getTenantDiscriminatorColumns(), getTenantDiscriminatorColumns())) {
return false;
}
return valuesMatch(persistenceUnitDefaults.getEntityListeners(), getEntityListeners());
}
return false;
}
@Override
public int hashCode() {
AccessMethodsMetadata accessMethods = getAccessMethods();
Boolean cascadePersist = getCascadePersist();
Boolean delimitedIdentifiers = getDelimitedIdentifiers();
List<EntityListenerMetadata> entityListeners = getEntityListeners();
List<TenantDiscriminatorColumnMetadata> tenantDiscriminatorColumns = getTenantDiscriminatorColumns();
String access = getAccess();
String catalog = getCatalog();
String schema = getSchema();
int result = accessMethods != null ? accessMethods.hashCode() : 0;
result = 31 * result + (cascadePersist != null ? cascadePersist.hashCode() : 0);
result = 31 * result + (delimitedIdentifiers != null ? delimitedIdentifiers.hashCode() : 0);
result = 31 * result + (entityListeners != null ? entityListeners.hashCode() : 0);
result = 31 * result + (tenantDiscriminatorColumns != null ? tenantDiscriminatorColumns.hashCode() : 0);
result = 31 * result + (access != null ? access.hashCode() : 0);
result = 31 * result + (catalog != null ? catalog.hashCode() : 0);
result = 31 * result + (schema != null ? schema.hashCode() : 0);
return result;
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public String getAccess() {
return m_access;
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public AccessMethodsMetadata getAccessMethods() {
return m_accessMethods;
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public Boolean getCascadePersist() {
return m_cascadePersist;
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public String getCatalog() {
return m_catalog;
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public Boolean getDelimitedIdentifiers() {
return m_delimitedIdentifiers;
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public List<EntityListenerMetadata> getEntityListeners() {
return m_entityListeners;
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public String getSchema() {
return m_schema;
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public List<TenantDiscriminatorColumnMetadata> getTenantDiscriminatorColumns() {
return m_tenantDiscriminatorColumns;
}
/**
* INTERNAL:
*/
public boolean hasAccessMethods() {
return m_accessMethods != null;
}
/**
* INTERNAL:
*/
@Override
public void initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings) {
super.initXMLObject(accessibleObject, entityMappings);
// Initialize single objects.
initXMLObject(m_accessMethods, accessibleObject);
// Initialize lists of ORMetadata objects.
initXMLObjects(m_entityListeners, accessibleObject);
initXMLObjects(m_tenantDiscriminatorColumns, accessibleObject);
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public boolean isCascadePersist() {
return m_cascadePersist != null && m_cascadePersist.booleanValue();
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public boolean isDelimitedIdentifiers(){
return m_delimitedIdentifiers != null && m_delimitedIdentifiers.booleanValue();
}
/**
* INTERNAL:
*/
@Override
public void merge(ORMetadata metadata) {
XMLPersistenceUnitDefaults persistenceUnitDefaults = (XMLPersistenceUnitDefaults) metadata;
if (persistenceUnitDefaults != null) {
// Simple object merging.
m_cascadePersist = (Boolean) mergeSimpleObjects(m_cascadePersist, persistenceUnitDefaults.getCascadePersist(), persistenceUnitDefaults, "cascade-persist");
m_delimitedIdentifiers = (Boolean) mergeSimpleObjects(m_delimitedIdentifiers, persistenceUnitDefaults.getDelimitedIdentifiers(), persistenceUnitDefaults, "delimited-identifiers");
m_access = (String) mergeSimpleObjects(m_access, persistenceUnitDefaults.getAccess(), persistenceUnitDefaults, "<access>");
m_catalog = (String) mergeSimpleObjects(m_catalog, persistenceUnitDefaults.getCatalog(), persistenceUnitDefaults, "<catalog>");
m_schema = (String) mergeSimpleObjects(m_schema, persistenceUnitDefaults.getSchema(), persistenceUnitDefaults, "<schema>");
// ORMetadata object merging.
m_accessMethods = (AccessMethodsMetadata) mergeORObjects(m_accessMethods, persistenceUnitDefaults.getAccessMethods());
// ORMetadata list merging.
m_entityListeners = mergeORObjectLists(m_entityListeners, persistenceUnitDefaults.getEntityListeners());
m_tenantDiscriminatorColumns = mergeORObjectLists(m_tenantDiscriminatorColumns, persistenceUnitDefaults.getTenantDiscriminatorColumns());
}
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public void setAccess(String access) {
m_access = access;
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public void setAccessMethods(AccessMethodsMetadata accessMethods){
m_accessMethods = accessMethods;
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public void setCascadePersist(Boolean cascadePersist) {
m_cascadePersist = cascadePersist;
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public void setCatalog(String catalog) {
m_catalog = catalog;
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public void setDelimitedIdentifiers(Boolean delimitedIdentifiers){
m_delimitedIdentifiers = delimitedIdentifiers;
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public void setEntityListeners(List<EntityListenerMetadata> entityListeners) {
m_entityListeners = entityListeners;
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public void setSchema(String schema) {
m_schema = schema;
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public void setTenantDiscriminatorColumns(List<TenantDiscriminatorColumnMetadata> tenantDiscriminatorColumns) {
m_tenantDiscriminatorColumns = tenantDiscriminatorColumns;
}
}