org.eclipse.persistence.internal.oxm.mappings.DirectCollectionMapping Maven / Gradle / Ivy
/*
* Copyright (c) 2012, 2021 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:
// Blaise Doughan - 2.5 - initial implementation
package org.eclipse.persistence.internal.oxm.mappings;
import org.eclipse.persistence.core.descriptors.CoreDescriptor;
import org.eclipse.persistence.core.mappings.CoreAttributeAccessor;
import org.eclipse.persistence.core.mappings.converters.CoreConverter;
import org.eclipse.persistence.core.sessions.CoreSession;
import org.eclipse.persistence.internal.core.helper.CoreField;
import org.eclipse.persistence.internal.core.queries.CoreContainerPolicy;
import org.eclipse.persistence.internal.core.sessions.CoreAbstractSession;
import org.eclipse.persistence.internal.oxm.Marshaller;
import org.eclipse.persistence.internal.oxm.Unmarshaller;
import org.eclipse.persistence.internal.oxm.record.XMLRecord;
import org.eclipse.persistence.oxm.mappings.nullpolicy.AbstractNullPolicy;
public interface DirectCollectionMapping<
ABSTRACT_SESSION extends CoreAbstractSession,
ATTRIBUTE_ACCESSOR extends CoreAttributeAccessor,
CONTAINER_POLICY extends CoreContainerPolicy,
CONVERTER extends CoreConverter,
DESCRIPTOR extends CoreDescriptor,
FIELD extends CoreField,
MARSHALLER extends Marshaller,
SESSION extends CoreSession,
UNMARSHALLER extends Unmarshaller,
XML_RECORD extends XMLRecord> extends Mapping, XMLContainerMapping, XMLConverterMapping {
/**
* Return the class each element in the object's
* collection should be converted to, before the collection
* is inserted into the object.
* This is optional - if left null, the elements will be added
* to the object's collection unconverted.
*/
Class getAttributeElementClass();
AbstractNullPolicy getNullPolicy();
/**
* Return the converter on the mapping.
* A converter can be used to convert between the direct collection's object value and database value.
*/
CONVERTER getValueConverter();
boolean isCDATA();
boolean isCollapsingStringValues();
boolean isNormalizingStringValues();
/**
* Set the class each element in the object's
* collection should be converted to, before the collection
* is inserted into the object.
* This is optional - if left null, the elements will be added
* to the object's collection unconverted.
*/
void setAttributeElementClass(Class attributeElementClass);
/**
* Indicates that this mapping should collapse all string values before adding them
* to the collection on unmarshal. Collapse removes leading and trailing whitespaces, and replaces
* any sequence of whitespace characters with a single space.
*/
void setCollapsingStringValues(boolean collapse);
/**
* Set the field that holds the nested collection.
*/
void setField(FIELD field);
/**
* PUBLIC:
* Set the class each element in the database row's
* collection should be converted to, before the collection
* is inserted into the database.
* This is optional - if left null, the elements will be added
* to the database row's collection unconverted.
*/
void setFieldElementClass(Class fieldElementClass);
void setIsCDATA(boolean CDATA);
void setIsWriteOnly(boolean b);
/**
* Indicates that this mapping should normalize all string values before adding them
* to the collection on unmarshal. Normalize replaces any CR, LF or Tab characters with a
* single space character.
*/
void setNormalizingStringValues(boolean normalize);
void setNullPolicy(AbstractNullPolicy nullPolicyFromProperty);
/**
* Sets whether the mapping uses a single node.
* @param usesSingleNode True if the items in the collection are in a single node or false if each of the items in the collection is in its own node
*/
void setUsesSingleNode(boolean usesSingleNode);
/**
* Set the converter on the mapping.
* A converter can be used to convert between the direct collection's object value and database value.
*/
void setValueConverter(CONVERTER valueConverter);
/**
* Set the Mapping field name attribute to the given XPath String
* @param xpathString String
*/
void setXPath(String xpathString);
void useCollectionClassName(String concreteContainerClassName);
/**
* Checks whether the mapping uses a single node.
*
* @return True if the items in the collection are in a single node or false if each of the items in the collection is in its own node.
*/
boolean usesSingleNode();
void setNullValue(Object nullValue);
Object getNullValue();
}