org.eclipse.persistence.internal.jpa.metadata.converters.StructConverterMetadata Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of eclipselink Show documentation
Show all versions of eclipselink Show documentation
EclipseLink build based upon Git transaction b7c997804f
/*
* Copyright (c) 1998, 2018 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 v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0,
* or the Eclipse Distribution License v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
// Contributors:
// Oracle - initial API and implementation from Oracle TopLink
// 05/16/2008-1.0M8 Guy Pelletier
// - 218084: Implement metadata merging functionality between mapping files
// 03/27/2009-2.0 Guy Pelletier
// - 241413: JPA 2.0 Add EclipseLink support for Map type attributes
// 04/27/2010-2.1 Guy Pelletier
// - 309856: MappedSuperclasses from XML are not being initialized properly
// 03/24/2011-2.3 Guy Pelletier
// - 337323: Multi-tenant with shared schema support (part 1)
// 11/10/2011-2.4 Guy Pelletier
// - 357474: Address primaryKey option from tenant discriminator column
package org.eclipse.persistence.internal.jpa.metadata.converters;
import java.sql.Types;
import org.eclipse.persistence.config.StructConverterType;
import org.eclipse.persistence.exceptions.ValidationException;
import org.eclipse.persistence.internal.jpa.metadata.accessors.MetadataAccessor;
import org.eclipse.persistence.internal.jpa.metadata.accessors.mappings.MappingAccessor;
import org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataAnnotation;
import org.eclipse.persistence.internal.jpa.metadata.accessors.objects.MetadataClass;
import org.eclipse.persistence.mappings.DatabaseMapping;
import org.eclipse.persistence.mappings.foundation.AbstractDirectMapping;
/**
* INTERNAL:
* Place holder for a StructConverter
*
* This class will allow a StructConverter to be added to a Session through
* annotations when defined with the StructConverter annotation.
*
* 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.
*
*/
public class StructConverterMetadata extends AbstractConverterMetadata {
private String m_converter;
/**
* INTERNAL:
* Used for XML loading.
*/
public StructConverterMetadata() {
super("");
}
/**
* INTERNAL:
* Used for annotation loading.
*/
public StructConverterMetadata(MetadataAnnotation structConverter, MetadataAccessor accessor) {
super(structConverter, accessor);
setConverter(structConverter.getAttributeString("converter"));
}
/**
* INTERNAL:
*/
@Override
public boolean equals(Object objectToCompare) {
if (super.equals(objectToCompare) && objectToCompare instanceof StructConverterMetadata) {
StructConverterMetadata structConverter = (StructConverterMetadata) objectToCompare;
return valuesMatch(m_converter, structConverter.getConverter());
}
return false;
}
@Override
public int hashCode() {
int result = super.hashCode();
result = 31 * result + (m_converter != null ? m_converter.hashCode() : 0);
return result;
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public String getConverter() {
return m_converter;
}
/**
* INTERNAL:
*/
public String getConverterClassName(){
if (getConverter().equals(StructConverterType.JGeometry)) {
return "org.eclipse.persistence.platform.database.oracle.converters.JGeometryConverter";
}
return getConverter();
}
/**
* INTERNAL:
*/
@Override
public boolean isStructConverter() {
return true;
}
/**
* INTERNAL:
*/
public void process(DatabaseMapping mapping, MappingAccessor accessor, MetadataClass referenceClass, boolean isForMapKey) {
if (mapping.isAbstractDirectMapping()) {
AbstractDirectMapping directMapping = ((AbstractDirectMapping) mapping);
directMapping.setFieldType(Types.STRUCT);
directMapping.setConverter(null);
directMapping.setConverterClassName(null);
} else if (!(mapping.isDirectCollectionMapping() || mapping.isDirectMapMapping())){
throw ValidationException.invalidMappingForStructConverter(getName(), mapping);
}
}
/**
* INTERNAL:
* Used for OX mapping.
*/
public void setConverter(String converter) {
m_converter = converter;
}
}