Skip to content

Commit

Permalink
[#1307] Split processor in two types, extend documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
flomickl committed Feb 25, 2023
1 parent 4e8de86 commit 502d05e
Show file tree
Hide file tree
Showing 12 changed files with 348 additions and 76 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,8 @@
import org.apache.streampipes.processors.geo.jvm.jts.processor.latlngtojtspoint.LatLngToJtsPointProcessor;
import org.apache.streampipes.processors.geo.jvm.jts.processor.reprojection.ReprojectionProcessor;
import org.apache.streampipes.processors.geo.jvm.jts.processor.trajectory.TrajectoryFromPointsProcessor;
import org.apache.streampipes.processors.geo.jvm.jts.processor.validation.GeometryValidationProcessor;
import org.apache.streampipes.processors.geo.jvm.jts.processor.validation.complex.TopologyValidationProcessor;
import org.apache.streampipes.processors.geo.jvm.jts.processor.validation.simple.GeometryValidationProcessor;
import org.apache.streampipes.processors.geo.jvm.latlong.processor.distancecalculator.haversine.HaversineDistanceCalculatorProcessor;
import org.apache.streampipes.processors.geo.jvm.latlong.processor.distancecalculator.haversinestatic.HaversineStaticDistanceCalculatorProcessor;
import org.apache.streampipes.processors.geo.jvm.latlong.processor.geocoder.googlemaps.GoogleMapsGeocoderProcessor;
Expand Down Expand Up @@ -72,7 +73,8 @@ public SpServiceDefinition provideServiceDefinition() {
new TrajectoryFromPointsProcessor(),
new SpeedCalculatorProcessor(),
new ReprojectionProcessor(),
new GeometryValidationProcessor())
new GeometryValidationProcessor(),
new TopologyValidationProcessor())
.registerMessagingFormats(
new JsonDataFormatFactory(),
new CborDataFormatFactory(),
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.apache.streampipes.processors.geo.jvm.jts.exceptions;

public class SpJtsGeoemtryException extends Exception {

public SpJtsGeoemtryException() {
}

public SpJtsGeoemtryException(String message) {
super(message);
}

public SpJtsGeoemtryException(String message, Throwable cause) {
super(message, cause);
}

public SpJtsGeoemtryException(Throwable cause) {
super(cause);
}

public SpJtsGeoemtryException(String message, Throwable cause, boolean enableSuppression,
boolean writableStackTrace) {
super(message, cause, enableSuppression, writableStackTrace);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,6 @@
package org.apache.streampipes.processors.geo.jvm.jts.processor.validation;

public enum ValidationOutput {
VALID(1), INVALID(2);

private final int number;

ValidationOutput(int number) {
this.number = number;
}

public int getNumber() {
return number;
}
VALID, INVALID;
}

Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,5 @@

package org.apache.streampipes.processors.geo.jvm.jts.processor.validation;
public enum ValidationType {
IsEmpty(1), IsValid(2), IsSimple(3);
private final int number;
ValidationType(int i) {
this.number = i;
}

public int getNumber() {
return number;
}
IsEmpty, IsValid, IsSimple;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.apache.streampipes.processors.geo.jvm.jts.processor.validation.complex;

import org.apache.streampipes.commons.exceptions.SpRuntimeException;
import org.apache.streampipes.extensions.management.monitoring.SpMonitoringManager;
import org.apache.streampipes.model.DataProcessorType;
import org.apache.streampipes.model.StreamPipesErrorMessage;
import org.apache.streampipes.model.graph.DataProcessorDescription;
import org.apache.streampipes.model.monitoring.SpLogEntry;
import org.apache.streampipes.model.runtime.Event;
import org.apache.streampipes.model.schema.PropertyScope;
import org.apache.streampipes.processors.geo.jvm.jts.exceptions.SpJtsGeoemtryException;
import org.apache.streampipes.processors.geo.jvm.jts.helper.SpGeometryBuilder;
import org.apache.streampipes.processors.geo.jvm.jts.processor.validation.ValidationOutput;
import org.apache.streampipes.sdk.builder.ProcessingElementBuilder;
import org.apache.streampipes.sdk.builder.StreamRequirementsBuilder;
import org.apache.streampipes.sdk.helpers.EpRequirements;
import org.apache.streampipes.sdk.helpers.Labels;
import org.apache.streampipes.sdk.helpers.Locales;
import org.apache.streampipes.sdk.helpers.Options;
import org.apache.streampipes.sdk.helpers.OutputStrategies;
import org.apache.streampipes.sdk.utils.Assets;
import org.apache.streampipes.wrapper.context.EventProcessorRuntimeContext;
import org.apache.streampipes.wrapper.routing.SpOutputCollector;
import org.apache.streampipes.wrapper.standalone.ProcessorParams;
import org.apache.streampipes.wrapper.standalone.StreamPipesDataProcessor;

import org.locationtech.jts.geom.Geometry;
import org.locationtech.jts.operation.valid.IsValidOp;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class TopologyValidationProcessor extends StreamPipesDataProcessor {
public static final String GEOM_KEY = "geom-key";
public static final String EPSG_KEY = "epsg-key";
public static final String VALIDATION_OUTPUT_KEY = "validation-output-key";
public static final String LOG_OUTPUT_KEY = "log-output-key";
private String geometryMapper;
private String epsgMapper;
private String outputChoice;
private boolean isLogOutput;
ProcessorParams params;
private static final Logger LOG = LoggerFactory.getLogger(TopologyValidationProcessor.class);

@Override
public DataProcessorDescription declareModel() {
return ProcessingElementBuilder.create("org.apache.streampipes.processors.geo.jvm.jts.processor.validation.complex")
.category(DataProcessorType.GEO)
.withAssets(Assets.DOCUMENTATION, Assets.ICON)
.withLocales(Locales.EN)
.requiredStream(StreamRequirementsBuilder
.create()
.requiredPropertyWithUnaryMapping(
EpRequirements.domainPropertyReq("http://www.opengis.net/ont/geosparql#Geometry"),
Labels.withId(GEOM_KEY),
PropertyScope.MEASUREMENT_PROPERTY)
.requiredPropertyWithUnaryMapping(
EpRequirements.domainPropertyReq("http://data.ign.fr/def/ignf#CartesianCS"),
Labels.withId(EPSG_KEY),
PropertyScope.MEASUREMENT_PROPERTY)
.build())
.outputStrategy(OutputStrategies.keep())
.requiredSingleValueSelection(
Labels.withId(VALIDATION_OUTPUT_KEY),
Options.from(
ValidationOutput.VALID.name(),
ValidationOutput.INVALID.name()
)
)
.requiredSlideToggle(
Labels.withId(LOG_OUTPUT_KEY),
false)
.build();
}

@Override
public void onInvocation(ProcessorParams parameters, SpOutputCollector spOutputCollector,
EventProcessorRuntimeContext runtimeContext) throws SpRuntimeException {

this.params = parameters;
this.geometryMapper = parameters.extractor().mappingPropertyValue(GEOM_KEY);
this.epsgMapper = parameters.extractor().mappingPropertyValue(EPSG_KEY);
this.isLogOutput = parameters.extractor().slideToggleValue(LOG_OUTPUT_KEY);
String readValidationOutput = parameters.extractor().selectedSingleValue(VALIDATION_OUTPUT_KEY, String.class);

if (readValidationOutput.equals(ValidationOutput.VALID.name())) {
this.outputChoice = ValidationOutput.VALID.name();
} else {
this.outputChoice = ValidationOutput.INVALID.name();
}
}

@Override
public void onEvent(Event event, SpOutputCollector collector) throws SpRuntimeException {
String geom = event.getFieldBySelector(geometryMapper).getAsPrimitive().getAsString();
Integer epsg = event.getFieldBySelector(epsgMapper).getAsPrimitive().getAsInt();

Geometry geometry = SpGeometryBuilder.createSPGeom(geom, epsg);
IsValidOp validator = new IsValidOp(geometry);
validator.setSelfTouchingRingFormingHoleValid(true);
boolean itIsValid = validator.isValid();
if (!itIsValid){
if (isLogOutput) {
SpMonitoringManager.INSTANCE.addErrorMessage(params.getGraph().getElementId(),
SpLogEntry.from(System.currentTimeMillis(),
StreamPipesErrorMessage.from(new SpJtsGeoemtryException(
validator.getValidationError().toString()))));
}
}

if (outputChoice.equals(ValidationOutput.VALID.name())) {
if (itIsValid) {
collector.collect(event);
}
} else if (outputChoice.equals(ValidationOutput.INVALID.name())) {
if (!itIsValid) {
collector.collect(event);
}
}
}

@Override
public void onDetach() throws SpRuntimeException {

}
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,16 @@
*
*/

package org.apache.streampipes.processors.geo.jvm.jts.processor.validation;
package org.apache.streampipes.processors.geo.jvm.jts.processor.validation.simple;

import org.apache.streampipes.commons.exceptions.SpRuntimeException;
import org.apache.streampipes.model.DataProcessorType;
import org.apache.streampipes.model.graph.DataProcessorDescription;
import org.apache.streampipes.model.runtime.Event;
import org.apache.streampipes.model.schema.PropertyScope;
import org.apache.streampipes.processors.geo.jvm.jts.helper.SpGeometryBuilder;
import org.apache.streampipes.processors.geo.jvm.jts.processor.validation.ValidationOutput;
import org.apache.streampipes.processors.geo.jvm.jts.processor.validation.ValidationType;
import org.apache.streampipes.sdk.builder.ProcessingElementBuilder;
import org.apache.streampipes.sdk.builder.StreamRequirementsBuilder;
import org.apache.streampipes.sdk.helpers.EpRequirements;
Expand All @@ -38,25 +40,28 @@
import org.apache.streampipes.wrapper.standalone.StreamPipesDataProcessor;

import org.locationtech.jts.geom.Geometry;
import org.locationtech.jts.operation.valid.IsValidOp;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.List;

public class GeometryValidationProcessor extends StreamPipesDataProcessor {
public static final String GEOM_KEY = "geom-key";
public static final String EPSG_KEY = "epsg-key";
public static final String VALIDATION_OUTPUT_KEY = "validation-output-key";
public static final String VALIDATION_TYPE_KEY = "validation-type-key";
private String geometryMapper;
private String epsgMapper;
private Integer validationOutput;
private Integer validationType;
private String outputChoice;
private boolean isEmptySelected;
private boolean isSimpleSelected;
private boolean isMultiSelected = false;

private static final Logger LOG = LoggerFactory.getLogger(GeometryValidationProcessor.class);

@Override
public DataProcessorDescription declareModel() {
return ProcessingElementBuilder.create("org.apache.streampipes.processors.geo.jvm.jts.processor.validation")
return ProcessingElementBuilder.create("org.apache.streampipes.processors.geo.jvm.jts.processor.validation.simple")
.category(DataProcessorType.GEO)
.withAssets(Assets.DOCUMENTATION, Assets.ICON)
.withLocales(Locales.EN)
Expand All @@ -79,12 +84,11 @@ public DataProcessorDescription declareModel() {
ValidationOutput.INVALID.name()
)
)
.requiredSingleValueSelection(
.requiredMultiValueSelection(
Labels.withId(VALIDATION_TYPE_KEY),
Options.from(
ValidationType.IsEmpty.name(),
ValidationType.IsSimple.name(),
ValidationType.IsValid.name()
ValidationType.IsSimple.name()
)
)
.build();
Expand All @@ -98,20 +102,24 @@ public void onInvocation(ProcessorParams parameters, SpOutputCollector spOutputC
this.epsgMapper = parameters.extractor().mappingPropertyValue(EPSG_KEY);

String readValidationOutput = parameters.extractor().selectedSingleValue(VALIDATION_OUTPUT_KEY, String.class);
String readValidationType = parameters.extractor().selectedSingleValue(VALIDATION_TYPE_KEY, String.class);
List<String> readValidationType = parameters.extractor().selectedMultiValues(VALIDATION_TYPE_KEY, String.class);

if (readValidationOutput.equals(ValidationOutput.VALID.name())) {
this.validationOutput = ValidationOutput.VALID.getNumber(); // 1
this.outputChoice = ValidationOutput.VALID.name();
} else {
this.validationOutput = 2;
this.outputChoice = ValidationOutput.INVALID.name();
}

if (readValidationType.equals(ValidationType.IsEmpty.name())) {
this.validationType = ValidationType.IsEmpty.getNumber(); // 1
} else if (readValidationType.equals(ValidationType.IsValid.name())) {
this.validationType = ValidationType.IsSimple.getNumber(); // 2
} else {
this.validationType = ValidationType.IsValid.getNumber(); // 3
if (readValidationType.size() == 2) {
this.isEmptySelected = true;
this.isSimpleSelected = true;
this.isMultiSelected = true;
} else if (readValidationType.get(0).equals(ValidationType.IsEmpty.name())) {
this.isEmptySelected = true;
this.isSimpleSelected = false;
} else if (readValidationType.get(0).equals(ValidationType.IsSimple.name())) {
this.isEmptySelected = false;
this.isSimpleSelected = true;
}
}

Expand All @@ -122,41 +130,27 @@ public void onEvent(Event event, SpOutputCollector collector) throws SpRuntimeEx

Geometry geometry = SpGeometryBuilder.createSPGeom(geom, sourceEpsg);

boolean itIsValid = false;

switch (validationType) {
case 1:
itIsValid = !geometry.isEmpty();
break;
case 2:
itIsValid = geometry.isSimple();
break;
case 3:
IsValidOp validater = new IsValidOp(geometry);
validater.setSelfTouchingRingFormingHoleValid(true);
itIsValid = validater.isValid();
if (!itIsValid) {
validater.getValidationError();
}
}
boolean itIsNotValid = false;

if (isMultiSelected) {
itIsNotValid = geometry.isEmpty() || !geometry.isSimple();
} else if (isEmptySelected) {
itIsNotValid = geometry.isEmpty();
} else if (isSimpleSelected) {
itIsNotValid = !geometry.isSimple();
}

switch (validationOutput) {
case 1:
if (itIsValid) {
collector.collect(event);
}
break;
case 2:
if (!itIsValid) {
collector.collect(event);
}
break;
if (outputChoice.equals(ValidationOutput.VALID.name())) {
if (!itIsNotValid) {
collector.collect(event);
}
} else if (outputChoice.equals(ValidationOutput.INVALID.name())) {
if (itIsNotValid) {
collector.collect(event);
}
}
}



@Override
public void onDetach() throws SpRuntimeException {

Expand Down
Loading

0 comments on commit 502d05e

Please sign in to comment.