org.n52.svalbard.encode.AbstractXmlEncoder Maven / Gradle / Ivy
The newest version!
/*
* Copyright (C) 2015-2022 52°North Spatial Information Research GmbH
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.n52.svalbard.encode;
import java.util.function.Supplier;
import javax.inject.Inject;
import org.apache.xmlbeans.XmlObject;
import org.apache.xmlbeans.XmlOptions;
import org.n52.janmayen.http.MediaType;
import org.n52.janmayen.http.MediaTypes;
import org.n52.svalbard.encode.exception.EncodingException;
import org.n52.svalbard.encode.exception.NoEncoderForKeyException;
import org.n52.svalbard.util.XmlHelper;
/**
*
* @since 1.0.0
*
* @param the resulting type, the "Target"
* @param the input type, the "Source"
*/
public abstract class AbstractXmlEncoder extends AbstractDelegatingEncoder
implements SchemaAwareEncoder {
private Supplier xmlOptions;
public XmlOptions getXmlOptions() {
return xmlOptions.get();
}
@Inject
public void setXmlOptions(Supplier xmlOptions) {
this.xmlOptions = xmlOptions;
}
@Override
public T encode(S element) throws EncodingException {
return encode(element, EncodingContext.empty());
}
@Override
public MediaType getContentType() {
return MediaTypes.TEXT_XML;
}
protected XmlObject substitute(XmlObject elementToSubstitute, XmlObject substitutionElement) {
XmlObject substituteElement = XmlHelper.substituteElement(elementToSubstitute, substitutionElement);
substituteElement.set(substitutionElement);
return substituteElement;
}
public Encoder getEncoder(String namespace, T o) throws EncodingException {
return getAndCheck(getEncoderKey(namespace, o));
}
public Encoder getEncoder(String namespace, Class o) throws EncodingException {
return getAndCheck(getEncoderKey(namespace, o));
}
public Encoder getDocumentEncoder(String namespace, T o) throws EncodingException {
return getAndCheck(getDocumentEncoderKey(namespace, o));
}
public Encoder getDocumentEncoder(String namespace, Class o)
throws EncodingException {
return getAndCheck(getDocumentEncoderKey(namespace, o));
}
public Encoder getPropertyTypeEncoder(String namespace, T o) throws EncodingException {
return getAndCheck(getPropertyTypeEncoderKey(namespace, o));
}
public Encoder getPropertyTypeEncoder(String namespace, Class o)
throws EncodingException {
return getAndCheck(getPropertyTypeEncoderKey(namespace, o));
}
public Encoder getAndCheck(EncoderKey key) throws NoEncoderForKeyException {
Encoder encoder = getEncoder(key);
if (encoder == null) {
throw new NoEncoderForKeyException(key);
}
return encoder;
}
public XmlObject encodeObjectToXml(String namespace, T object, EncodingContext helperValues)
throws EncodingException {
return getEncoder(namespace, object).encode(object,
helperValues == null ? EncodingContext.empty() : helperValues);
}
public XmlObject encodeObjectToXml(String namespace, Object object) throws EncodingException {
return encodeObjectToXml(namespace, object, null);
}
public String encodeObjectToXmlText(String namespace, Object object, EncodingContext helperValues)
throws EncodingException {
return encodeObjectToXml(namespace, object, helperValues).xmlText(getXmlOptions());
}
public String encodeObjectToXmlText(String namespace, Object object) throws EncodingException {
return encodeObjectToXmlText(namespace, object, null);
}
public XmlObject encodeObjectToXmlDocument(String namespace, T object, EncodingContext helperValues)
throws EncodingException {
return getDocumentEncoder(namespace, object).encode(object,
helperValues == null ? EncodingContext.empty() : helperValues);
}
public XmlObject encodeObjectToXmlDocument(String namespace, Object object) throws EncodingException {
return encodeObjectToXmlDocument(namespace, object, null);
}
public XmlObject encodeObjectToXmlPropertyType(String namespace, T object, EncodingContext helperValues)
throws EncodingException {
return getPropertyTypeEncoder(namespace, object).encode(object,
helperValues == null ? EncodingContext.empty() : helperValues);
}
public XmlObject encodeObjectToXmlPropertyType(String namespace, Object object) throws EncodingException {
return encodeObjectToXmlPropertyType(namespace, object, null);
}
public EncoderKey getEncoderKey(String namespace, Object o) {
return new XmlEncoderKey(namespace, o.getClass());
}
public EncoderKey getEncoderKey(String namespace, Class o) {
return new XmlEncoderKey(namespace, o);
}
public EncoderKey getDocumentEncoderKey(String namespace, Object o) {
return new XmlDocumentEncoderKey(namespace, o.getClass());
}
public EncoderKey getDocumentEncoderKey(String namespace, Class o) {
return new XmlDocumentEncoderKey(namespace, o);
}
public EncoderKey getPropertyTypeEncoderKey(String namespace, Object o) {
return new XmlPropertyTypeEncoderKey(namespace, o.getClass());
}
public EncoderKey getPropertyTypeEncoderKey(String namespace, Class o) {
return new XmlPropertyTypeEncoderKey(namespace, o);
}
}