org.geotoolkit.xml.Pooled Maven / Gradle / Ivy
/*
* Geotoolkit.org - An Open Source Java GIS Toolkit
* http://www.geotoolkit.org
*
* (C) 2009-2012, Open Source Geospatial Foundation (OSGeo)
* (C) 2009-2012, Geomatys
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation;
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*/
package org.geotoolkit.xml;
import java.util.Map;
import java.util.LinkedHashMap;
import java.util.ConcurrentModificationException;
import java.util.Locale;
import java.util.TimeZone;
import javax.xml.bind.annotation.adapters.XmlAdapter;
import javax.xml.bind.ValidationEventHandler;
import javax.xml.bind.PropertyException;
import javax.xml.bind.JAXBException;
import javax.xml.validation.Schema;
import org.geotoolkit.util.Version;
import org.geotoolkit.util.Strings;
import org.geotoolkit.util.XArrays;
import org.geotoolkit.resources.Errors;
import org.geotoolkit.internal.InternalUtilities;
import org.geotoolkit.internal.jaxb.MarshalContext;
import static org.geotoolkit.internal.jaxb.MarshalContext.*;
/**
* Base class of {@link PooledMarshaller} and {@link PooledUnmarshaller}.
* This class provides basic service for saving the initial values of [un]marshaller properties,
* in order to reset them to their initial values after usage. This is required in order to allow
* [un]marshaller reuse. In addition this base class translate properties key from JDK 6 names to
* "endorsed JAR" names if needed.
*
* @author Martin Desruisseaux (Geomatys)
* @version 3.20
*
* @since 3.00
* @module
*/
abstract class Pooled {
/**
* The prefix of property names which are internal to Sun implementation of JAXB.
*/
private static final String INTERNAL = "com.sun.xml.bind.";
/**
* {@code true} if the JAXB implementation is the one bundled in JDK 6,
* or {@code false} if this is an external implementation like a JAR put
* in the endorsed directory.
*/
private final boolean internal;
/**
* The initial state of the [un]marshaller. Will be filled only as needed,
* often with null values (which must be supported by the map implementation).
*
*
* - For each entry having a key of type {@link Class}, the value is the argument
* to be given to a {@code marshaller.setFoo(value)} method.
* - For each entry having a key of type {@link String}, the value is the argument
* to be given to the {@code marshaller.setProperty(key, value)} method.
*
*/
private final Map initial;
/**
* The object converters to use during (un)marshalling.
* Can be set by the {@link XML#CONVERTERS} property.
*
* @since 3.07
*/
private ObjectConverters converters;
/**
* The object linker to use during unmarshalling.
* Can be set by the {@link XML#LINKER} property.
*
* @since 3.18
*/
private ObjectLinker linker;
/**
* The GML version to be marshalled or unmarshalled, or {@code null} if unspecified.
* If null, than the latest version is assumed.
*
* @since 3.20
*/
private Version versionGML;
/**
* The base URL of ISO 19139 (or other standards) schemas. It shall be an unmodifiable
* instance. The valid values are documented in the {@link XML#SCHEMAS} property.
*
* @since 3.17
*/
private Map schemas;
/**
* An optional locale for {@link org.opengis.util.InternationalString} and
* {@link org.opengis.util.CodeList}. Can be set by the {@link XML#LOCALE}
* property.
*
* @since 3.17
*/
private Locale locale;
/**
* The timezone, or {@code null} if unspecified.
* In the later case, the default timezone is used.
*
* @since 3.17
*/
private TimeZone timezone;
/**
* Bit masks for various boolean attributes. This include whatever the language codes or the
* country codes should be substituted by a simpler character string elements. Those bits are
* determined by the {@link XML#STRING_SUBSTITUTES} property.
*
* @since 3.18
*/
private int bitMasks;
/**
* Default constructor.
*
* @param internal {@code true} if the JAXB implementation is the one bundled in JDK 6,
* or {@code false} if this is an external implementation like a JAR put in the
* endorsed directory.
*/
Pooled(final boolean internal) {
this.internal = internal;
initial = new LinkedHashMap();
}
/**
* Resets the marshaller in its initial state.
*
* @throws JAXBException If an error occurred while restoring a property.
*/
public final void reset() throws JAXBException {
for (final Map.Entry entry : initial.entrySet()) {
reset(entry.getKey(), entry.getValue());
}
initial.clear();
converters = null;
linker = null;
versionGML = null;
schemas = null;
locale = null;
timezone = null;
}
/**
* Resets the given marshaller property to its initial state. This method is invoked
* automatically by the {@link #reset()} method. The key is either a {@link String}
* or a {@link Class}. If this is a string, then the value should be given to the
* {@code setProperty(key, value)} method. Otherwise the value should be given to
* {@code setFoo(value)} method where "Foo" is determined from the key.
*
* @param key The property to reset.
* @param value The initial value to give to the property.
* @throws JAXBException If an error occurred while restoring a property.
*/
protected abstract void reset(final Object key, final Object value) throws JAXBException;
/**
* Returns {@code true} if the state is already saved for the given key.
*/
final boolean containsKey(final Class key) {
return initial.containsKey(key);
}
/**
* Saves the current state of a property.
*/
final void save(final Class type, final E value) {
if (initial.put(type, value) != null) {
// Should never happen, unless on concurrent changes in a backgroung thread.
throw new ConcurrentModificationException(type.toString());
}
}
/**
* Converts a property key from the JAXB name to the underlying implementation name.
* This apply only to property key in the {@code "com.sun.xml.bind"} namespace.
*
* @param key The JAXB property key.
* @return The property key to use.
*/
private String convertPropertyKey(String key) {
if (internal && key.startsWith(INTERNAL)) {
key = "com.sun.xml.internal.bind." + key.substring(INTERNAL.length());
}
return key;
}
/**
* A method which is common to both {@code Marshaller} and {@code Unmarshaller}.
* It saves the initial state if it was not already done, but subclasses will
* need to complete the work.
*/
public final void setProperty(String name, final Object value) throws PropertyException {
try {
// TODO: Use strings in switch with JDK 7.
if (name.equals(XML.CONVERTERS)) {
converters = (ObjectConverters) value;
return;
}
if (name.equals(XML.LINKER)) {
linker = (ObjectLinker) value;
return;
}
if (name.equals(XML.SCHEMAS)) {
schemas = InternalUtilities.subset((Map) value, String.class, "gmd");
return;
}
if (name.equals(XML.GML_VERSION)) {
versionGML = (value instanceof CharSequence) ? new Version(value.toString()) : (Version) value;
return;
}
if (name.equals(XML.LOCALE)) {
locale = (Locale) value;
return;
}
if (name.equals(XML.TIMEZONE)) {
timezone = (TimeZone) value;
return;
}
if (name.equals(XML.STRING_SUBSTITUTES)) {
int mask = 0;
final String[] substitutes = Strings.split((String) value, ',');
if (XArrays.containsIgnoreCase(substitutes, "language")) mask |= SUBSTITUTE_LANGUAGE;
if (XArrays.containsIgnoreCase(substitutes, "country")) mask |= SUBSTITUTE_COUNTRY;
bitMasks = mask;
return;
}
} catch (ClassCastException e) {
throw new PropertyException(Errors.format(Errors.Keys.ILLEGAL_PROPERTY_TYPE_$2,
name, value.getClass()), e);
}
name = convertPropertyKey(name);
if (!initial.containsKey(name)) {
if (initial.put(name, getStandardProperty(name)) != null) {
// Should never happen, unless on concurrent changes in a backgroung thread.
throw new ConcurrentModificationException(name);
}
}
setStandardProperty(name, value);
}
/**
* A method which is common to both {@code Marshaller} and {@code Unmarshaller}.
*/
public final Object getProperty(final String name) throws PropertyException {
// TODO: Use strings in switch with JDK 7.
if (name.equals(XML.CONVERTERS)) {
return converters;
} else if (name.equals(XML.LINKER)) {
return linker;
} else if (name.equals(XML.SCHEMAS)) {
return schemas;
} else if (name.equals(XML.GML_VERSION)) {
return versionGML;
} else if (name.equals(XML.LOCALE)) {
return locale;
} else if (name.equals(XML.TIMEZONE)) {
return timezone;
} else if (name.equals(XML.STRING_SUBSTITUTES)) {
final StringBuilder buffer = new StringBuilder();
if ((bitMasks & SUBSTITUTE_LANGUAGE) != 0) buffer.append("language,");
if ((bitMasks & SUBSTITUTE_COUNTRY) != 0) buffer.append("country,");
final int length = buffer.length();
if (length != 0) {
buffer.setLength(length - 1); // Remove the last coma.
return buffer.toString();
}
return null;
} else {
return getStandardProperty(convertPropertyKey(name));
}
}
/**
* Sets the given property to the wrapped (un)marshaller. This method is invoked
* automatically when the property given to the {@link #setProperty(String, Object)}
* method was not one of the {@link XML} constants.
*
* @since 3.17
*/
abstract void setStandardProperty(String name, Object value) throws PropertyException;
/**
* Gets the given property from the wrapped (un)marshaller. This method is invoked
* automatically when the property key given to the {@link #getProperty(String)}
* method was not one of the {@link XML} constants.
*
* @since 3.17
*/
abstract Object getStandardProperty(String name) throws PropertyException;
/**
* Delegates to {@code setAdapter(adapter.getClass(), adapter)} as specified
* in {@code [Un]Marshaller} javadoc.
*/
@SuppressWarnings({"unchecked","rawtypes"})
public final void setAdapter(final XmlAdapter adapter) {
setAdapter((Class) adapter.getClass(), adapter);
}
/**
* A method which is common to both {@code Marshaller} and {@code Unmarshaller}.
* It saves the initial state if it was not already done, but subclasses will
* need to complete the work.
*/
@SuppressWarnings("rawtypes")
public void setAdapter(final Class type, final A adapter) {
if (!initial.containsKey(type)) {
save(type, getAdapter(type));
}
}
/**
* A method which is common to both {@code Marshaller} and {@code Unmarshaller}.
*/
@SuppressWarnings("rawtypes")
public abstract A getAdapter(final Class type);
/**
* A method which is common to both {@code Marshaller} and {@code Unmarshaller}.
* It saves the initial state if it was not already done, but subclasses will
* need to complete the work.
*/
public void setSchema(final Schema schema) {
if (!containsKey(Schema.class)) {
save(Schema.class, getSchema());
}
}
/**
* A method which is common to both {@code Marshaller} and {@code Unmarshaller}.
*/
public abstract Schema getSchema();
/**
* A method which is common to both {@code Marshaller} and {@code Unmarshaller}.
* It saves the initial state if it was not already done, but subclasses will
* need to complete the work.
*/
public void setEventHandler(final ValidationEventHandler handler) throws JAXBException {
if (!initial.containsKey(ValidationEventHandler.class)) {
save(ValidationEventHandler.class, getEventHandler());
}
}
/**
* A method which is common to both {@code Marshaller} and {@code Unmarshaller}.
*/
public abstract ValidationEventHandler getEventHandler() throws JAXBException;
/**
* Must be invoked by subclasses before a {@code try} block performing a (un)marshalling
* operation. Must be followed by a call to {@code finish()} in a {@code finally} block.
*
* {@preformat java
* MarshalProcess ctx = begin();
* try {
* ...
* } finally {
* ctx.finish();
* }
* }
*
* @since 3.07
*/
final MarshalContext begin() {
return MarshalContext.begin(converters, linker, versionGML, schemas, locale, timezone, bitMasks);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy