/*******************************************************************************
* Copyright (c) 2011, 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:
* James Sutherland - initial API and implementation
* 03/24/2011-2.3 Guy Pelletier
* - 337323: Multi-tenant with shared schema support (part 1)
* * 30/05/2012-2.4 Guy Pelletier
* - 354678: Temp classloader is still being used during metadata processing
******************************************************************************/
package org.eclipse.persistence.internal.jpa.metadata.partitioning;
import org.eclipse.persistence.descriptors.partitioning.FieldPartitioningPolicy;
import org.eclipse.persistence.descriptors.partitioning.PartitioningPolicy;
import org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor;
import org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAccessibleObject;
import org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotation;
import org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataClass;
import org.eclipse.persistence.internal.jpa.metadata.columns.ColumnMetadata;
import org.eclipse.persistence.internal.jpa.metadata.xml.XMLEntityMappings;
/**
* INTERNAL:
* Define JPA meta-data for partitioning policy.
*
* 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 James Sutherland
* @since EclipseLink 2.2
*/
public abstract class FieldPartitioningMetadata extends AbstractPartitioningMetadata {
protected Boolean unionUnpartitionableQueries;
protected ColumnMetadata partitionColumn;
protected MetadataClass partitionValueType;
protected String partitionValueTypeName;
/**
* INTERNAL:
* Used for XML loading.
*/
public FieldPartitioningMetadata() {
super("<field-partitioning>");
}
/**
* INTERNAL:
* Used for annotation loading.
*/
public FieldPartitioningMetadata(MetadataAnnotation annotation, MetadataAccessor accessor) {
super(annotation, accessor);
if (annotation.hasAttribute("partitionColumn")) {
this.partitionColumn = new ColumnMetadata(annotation.getAttributeAnnotation("partitionColumn"), accessor);
}
this.partitionValueType = getMetadataClass(annotation.getAttributeClass("partitionValueType", String.class));
this.unionUnpartitionableQueries = annotation.getAttributeBooleanDefaultFalse("unionUnpartitionableQueries");
}
/**
* INTERNAL:
* Used for XML loading.
*/
protected FieldPartitioningMetadata(String elementName) {
super(elementName);
}
/**
* INTERNAL:
* Used for XML merging and overriding.
*/
@Override
public boolean equals(Object objectToCompare) {
if (super.equals(objectToCompare) && (objectToCompare instanceof FieldPartitioningMetadata)) {
FieldPartitioningMetadata policy = (FieldPartitioningMetadata) objectToCompare;
return valuesMatch(this.partitionColumn, policy.getPartitionColumn())
&& valuesMatch(this.unionUnpartitionableQueries, policy.getUnionUnpartitionableQueries())
&& valuesMatch(this.partitionValueTypeName, policy.getPartitionValueTypeName());
}
return false;
}
@Override
public int hashCode() {
int result = super.hashCode();
result = 31 * result + (unionUnpartitionableQueries != null ? unionUnpartitionableQueries.hashCode() : 0);
result = 31 * result + (partitionColumn != null ? partitionColumn.hashCode() : 0);
result = 31 * result + (partitionValueTypeName != null ? partitionValueTypeName.hashCode() : 0);
return result;
}
/**
* Set common fields into policy.
* Should be called by subclasses.
*/
@Override
public void buildPolicy(PartitioningPolicy policy) {
super.buildPolicy(policy);
if (this.partitionColumn != null) {
((FieldPartitioningPolicy)policy).setPartitionField(this.partitionColumn.getDatabaseField());
}
if (this.unionUnpartitionableQueries != null) {
((FieldPartitioningPolicy)policy).setUnionUnpartitionableQueries(this.unionUnpartitionableQueries);
}
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public ColumnMetadata getPartitionColumn() {
return partitionColumn;
}
/**
* INTERNAL:
*/
public MetadataClass getPartitionValueType() {
return partitionValueType;
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public String getPartitionValueTypeName() {
return partitionValueTypeName;
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public Boolean getUnionUnpartitionableQueries() {
return unionUnpartitionableQueries;
}
/**
* INTERNAL:
*/
@Override
public void initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings) {
super.initXMLObject(accessibleObject, entityMappings);
// Initialize single objects.
initXMLObject(partitionColumn, accessibleObject);
// Initialize the partition value type name we read from XML else default it to String.class
if (partitionValueTypeName != null) {
partitionValueType = initXMLClassName(partitionValueTypeName);
} else {
partitionValueType = getMetadataClass(String.class);
}
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public void setPartitionColumn(ColumnMetadata partitionColumn) {
this.partitionColumn = partitionColumn;
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public void setPartitionValueTypeName(String partitionValueTypeName) {
this.partitionValueTypeName = partitionValueTypeName;
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public void setUnionUnpartitionableQueries(Boolean unionUnpartitionableQueries) {
this.unionUnpartitionableQueries = unionUnpartitionableQueries;
}
}