/*******************************************************************************
* Copyright (c) 2011, 2012 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)
******************************************************************************/
package org.eclipse.persistence.internal.jpa.metadata.partitioning;
import org.eclipse.persistence.descriptors.partitioning.CustomPartitioningPolicy;
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.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 class PartitioningMetadata extends AbstractPartitioningMetadata {
protected String className;
/**
* INTERNAL:
* Used for XML loading.
*/
public PartitioningMetadata() {
super("<partitioning>");
}
/**
* INTERNAL:
* Used for annotation loading.
*/
public PartitioningMetadata(MetadataAnnotation annotation, MetadataAccessor accessor) {
super(annotation, accessor);
this.className = (String)annotation.getAttribute("partitioningClass");
}
/**
* Cannot instantiate policy until the correct class loader is available.
*/
@Override
public PartitioningPolicy buildPolicy() {
CustomPartitioningPolicy policy = new CustomPartitioningPolicy();
super.buildPolicy(policy);
policy.setPartitioningClasName(this.className);
return policy;
}
/**
* INTERNAL:
* For merging and overriding to work properly, all ORMetadata must be able
* to compare themselves for metadata equality.
*/
@Override
public boolean equals(Object objectToCompare) {
if (super.equals(objectToCompare) && (objectToCompare instanceof PartitioningMetadata)) {
PartitioningMetadata policy = (PartitioningMetadata) objectToCompare;
return valuesMatch(this.className, policy.getClassName());
}
return false;
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public String getClassName() {
return this.className;
}
/**
* INTERNAL:
*/
@Override
public void initXMLObject(MetadataAccessibleObject accessibleObject, XMLEntityMappings entityMappings) {
super.initXMLObject(accessibleObject, entityMappings);
this.className = initXMLClassName(this.className).getName();
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public void setClassName(String className) {
this.className = className;
}
}