org.n52.sos.ds.procedure.ProcedureConverter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of handler Show documentation
Show all versions of handler Show documentation
52°North SOS Handler Module
The newest version!
/*
* Copyright (C) 2012-2019 52°North Initiative for Geospatial Open Source
* Software GmbH
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 as published
* by the Free Software Foundation.
*
* If the program is linked with libraries which are licensed under one of
* the following licenses, the combination of the program with the linked
* library is not considered a "derivative work" of the program:
*
* - Apache License, version 2.0
* - Apache Software License, version 1.0
* - GNU Lesser General Public License, version 3
* - Mozilla Public License, versions 1.0, 1.1 and 2.0
* - Common Development and Distribution License (CDDL), version 1.0
*
* Therefore the distribution of the program linked with libraries licensed
* under the aforementioned licenses, is permitted by the copyright holders
* if the distribution is compliant with both the GNU General Public
* License version 2 and the aforementioned licenses.
*
* This program 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 General
* Public License for more details.
*/
package org.n52.sos.ds.procedure;
import java.util.ArrayList;
import java.util.Locale;
import javax.inject.Inject;
import org.hibernate.Session;
import org.n52.iceland.convert.Converter;
import org.n52.iceland.convert.ConverterException;
import org.n52.iceland.util.LocalizedProducer;
import org.n52.janmayen.http.HTTPStatus;
import org.n52.series.db.beans.ProcedureEntity;
import org.n52.shetland.ogc.gml.AbstractFeature;
import org.n52.shetland.ogc.gml.time.TimePeriod;
import org.n52.shetland.ogc.ows.OwsServiceProvider;
import org.n52.shetland.ogc.ows.exception.InvalidParameterValueException;
import org.n52.shetland.ogc.ows.exception.NoApplicableCodeException;
import org.n52.shetland.ogc.ows.exception.OwsExceptionReport;
import org.n52.shetland.ogc.sensorML.AbstractProcess;
import org.n52.shetland.ogc.sensorML.SensorML;
import org.n52.shetland.ogc.sos.SosConstants;
import org.n52.shetland.ogc.sos.SosProcedureDescription;
import org.n52.sos.ds.procedure.create.DescriptionCreationStrategy;
import org.n52.sos.ds.procedure.create.GeneratedDescriptionCreationStrategy;
import org.n52.sos.ds.procedure.enrich.ProcedureDescriptionEnrichments;
import org.n52.sos.ds.procedure.generator.ProcedureDescriptionGeneratorFactoryRepository;
import com.google.common.base.Optional;
import com.google.common.collect.Lists;
/**
* @author Eike
* HinderkJürrens
* @author Carsten Hollmann
* @author Christian Autermann
* @author Shane StClair
*
* @since 4.0.0
*
* TODO - apply description enrichment to all types of procedures
* (creates, file, or database) - use setting switches for code flow
*/
public class ProcedureConverter extends AbstractProcedureConverter {
private LocalizedProducer serviceProvider;
private ProcedureCreationContext ctx;
@Inject
public ProcedureConverter(ProcedureCreationContext ctx) {
this.ctx = ctx;
this.serviceProvider = ctx.getServiceMetadataRepository().getServiceProviderFactory(SosConstants.SOS);
}
@Override
public SosProcedureDescription createSosProcedureDescription(ProcedureEntity procedure,
String requestedDescriptionFormat, String requestedServiceVersion, Locale i18n, Session session)
throws OwsExceptionReport {
if (procedure == null) {
throw new NoApplicableCodeException()
.causedBy(new IllegalArgumentException("Parameter 'procedure' should not be null!"))
.setStatus(HTTPStatus.INTERNAL_SERVER_ERROR);
}
checkOutputFormatWithDescriptionFormat(procedure.getIdentifier(), requestedDescriptionFormat);
SosProcedureDescription desc = create(procedure, requestedDescriptionFormat, i18n, session).orNull();
if (desc != null) {
addHumanReadableName(desc, procedure);
enrich(desc, procedure, requestedServiceVersion, requestedDescriptionFormat, null, i18n, session);
if (!requestedDescriptionFormat.equals(desc.getDescriptionFormat())) {
desc = convert(desc.getDescriptionFormat(), requestedDescriptionFormat, desc);
desc.setDescriptionFormat(requestedDescriptionFormat);
}
}
return desc;
}
private void addHumanReadableName(SosProcedureDescription desc, ProcedureEntity procedure) {
if (!desc.isSetHumanReadableIdentifier() && procedure.isSetName()) {
desc.setHumanReadableIdentifier(procedure.getName());
}
}
private Optional> create(ProcedureEntity procedure, String descriptionFormat,
Locale i18n, Session session) throws OwsExceptionReport {
Optional strategy = getCreationStrategy(procedure);
if (strategy.isPresent()) {
return Optional.fromNullable(strategy.get().create(procedure, descriptionFormat, i18n, session));
} else {
return Optional.absent();
}
}
private Optional getCreationStrategy(ProcedureEntity p) {
for (DescriptionCreationStrategy strategy : getCreationStrategies()) {
if (strategy.apply(p)) {
return Optional.of(strategy);
}
}
return Optional.absent();
}
protected ArrayList getCreationStrategies() {
return Lists.newArrayList(new GeneratedDescriptionCreationStrategy(
(ProcedureDescriptionGeneratorFactoryRepository) ctx.getFactoryRepository()));
}
/**
* Checks the requested procedureDescriptionFormat with the datasource
* procedureDescriptionFormat.
*
* @param identifier
*
* @param identifier
* the procedure identifier
* @param requestedFormat
* requested procedureDescriptionFormat
*
* @throws OwsExceptionReport
* If procedureDescriptionFormats are invalid
*/
private boolean checkOutputFormatWithDescriptionFormat(String identifier, String requestedFormat)
throws OwsExceptionReport {
if (existsGenerator(requestedFormat)) {
return true;
}
throw new InvalidParameterValueException().at(SosConstants.DescribeSensorParams.procedure)
.withMessage("The value of the output format is wrong and has to be %s for procedure %s",
requestedFormat, identifier)
.setStatus(HTTPStatus.BAD_REQUEST);
}
private boolean existsGenerator(String descriptionFormat) {
return ctx.getFactoryRepository().hasProcedureDescriptionGeneratorFactory(descriptionFormat);
}
/**
* Enrich the procedure description.
*
* @param desc
* the description
* @param procedure
* the procedure
* @param version
* the version
* @param format
* the format
* @param validTime
* the time for which the description shoul dbe valid
* @param language
* the language
* @param session
* the session
*
* @see HibernateProcedureEnrichment
* @throws OwsExceptionReport
* if the enrichment fails
*/
private void enrich(SosProcedureDescription desc, ProcedureEntity procedure, String version, String format,
TimePeriod validTime, Locale language, Session session) throws OwsExceptionReport {
ProcedureDescriptionEnrichments enrichments =
new ProcedureDescriptionEnrichments(language, serviceProvider, ctx);
enrichments.setIdentifier(procedure.getIdentifier()).setProcedure(procedure).setVersion(version)
.setDescription(desc).setProcedureDescriptionFormat(format).setSession(session).setValidTime(validTime)
.setConverter(this);
// if (procedure.isSetTypeOf() && desc.getProcedureDescription()
// instanceof AbstractProcessV20) {
// Procedure typeOf = procedure.getTypeOf();
// enrichments.setTypeOfIdentifier(typeOf.getIdentifier()).setTypeOfFormat(format);
// }
if (desc.getProcedureDescription() instanceof SensorML
&& ((SensorML) desc.getProcedureDescription()).isWrapper()) {
enrichments.setDescription(desc).createValidTimeEnrichment().enrich();
for (AbstractProcess abstractProcess : ((SensorML) desc.getProcedureDescription()).getMembers()) {
SosProcedureDescription sosProcedureDescription =
new SosProcedureDescription<>(abstractProcess);
enrichments.setDescription(sosProcedureDescription).enrichAll();
}
} else {
enrichments.enrichAll();
}
}
/**
* Convert the description to another procedure description format.
*
* @param fromFormat
* the source format
* @param toFormat
* the target format
* @param description
* the procedure description.
*
* @return the converted description
*
* @throws OwsExceptionReport
* if conversion fails
*/
private SosProcedureDescription convert(String fromFormat, String toFormat,
SosProcedureDescription description) throws OwsExceptionReport {
try {
Converter converter =
ctx.getConverterRepository().getConverter(fromFormat, toFormat);
if (converter != null) {
AbstractFeature convert = converter.convert(description);
if (convert instanceof SosProcedureDescription) {
return (SosProcedureDescription) convert;
} else {
return new SosProcedureDescription(convert).add(description);
}
}
throw new ConverterException(
String.format("No converter available to convert from '%s' to '%s'", fromFormat, toFormat));
} catch (ConverterException ce) {
throw new NoApplicableCodeException().causedBy(ce)
.withMessage("Error while processing data for DescribeSensor document!");
}
}
}