Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add recordPath option to JsonDecoder #384

Merged
merged 3 commits into from
Aug 27, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions metafacture-json/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ description = 'Modules for processing JSON data in Metafacture'
dependencies {
api project(':metafacture-framework')
implementation 'com.fasterxml.jackson.core:jackson-core:2.8.5'
implementation 'com.fasterxml.jackson.core:jackson-databind:2.8.5'
implementation 'com.jayway.jsonpath:json-path:2.6.0'
testImplementation 'junit:junit:4.12'
testImplementation 'org.mockito:mockito-core:2.5.5'
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2017 hbz
* Copyright 2017, 2021 hbz
*
* Licensed under the Apache License, Version 2.0 the "License";
* you may not use this file except in compliance with the License.
Expand All @@ -17,19 +17,35 @@

import com.fasterxml.jackson.core.JsonFactory;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.core.JsonToken;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.jayway.jsonpath.JsonPath;

import org.metafacture.framework.FluxCommand;
import org.metafacture.framework.MetafactureException;
import org.metafacture.framework.StreamReceiver;
import org.metafacture.framework.annotations.Description;
import org.metafacture.framework.annotations.In;
import org.metafacture.framework.annotations.Out;
import org.metafacture.framework.helpers.DefaultObjectPipe;

import java.io.IOException;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;

/**
* Decodes a record in JSON format.
*
* @author Jens Wille
*
*/
@Description("Decodes JSON to metadata events. The \'recordPath\' option can be used to set a JsonPath "
+ "to extract a path as JSON - or to split the data into multiple JSON documents.")
@In(String.class)
@Out(StreamReceiver.class)
@FluxCommand("decode-json")
public final class JsonDecoder extends DefaultObjectPipe<String, StreamReceiver> {

public static final String DEFAULT_ARRAY_MARKER = JsonEncoder.ARRAY_MARKER;
Expand All @@ -38,6 +54,8 @@ public final class JsonDecoder extends DefaultObjectPipe<String, StreamReceiver>

public static final String DEFAULT_RECORD_ID = "%d";

public static final String DEFAULT_ROOT_PATH = "";

private final JsonFactory jsonFactory = new JsonFactory();

private JsonParser jsonParser;
Expand All @@ -46,12 +64,15 @@ public final class JsonDecoder extends DefaultObjectPipe<String, StreamReceiver>
private String recordId;
private int recordCount;

private String recordPath;

public JsonDecoder() {
super();

setArrayMarker(DEFAULT_ARRAY_MARKER);
setArrayName(DEFAULT_ARRAY_NAME);
setRecordId(DEFAULT_RECORD_ID);
setRecordPath(DEFAULT_ROOT_PATH);

resetRecordCount();
}
Expand Down Expand Up @@ -96,25 +117,45 @@ public int getRecordCount() {
return recordCount;
}

public void setRecordPath(final String recordPath) {
this.recordPath = recordPath;
}

public String getRecordPath() {
return recordPath;
}

public void resetRecordCount() {
setRecordCount(0);
}

@Override
public void process(final String string) {
public void process(final String json) {
assert !isClosed();

createParser(string);

try {
decode();
}
catch (final IOException e) {
throw new MetafactureException(e);
}
finally {
closeParser();
}
final List<String> records = recordPath.isEmpty() ? Arrays.asList(json)
: matches(JsonPath.read(json, recordPath));
records.forEach(record -> {
createParser(record);
try {
decode();
} catch (final IOException e) {
throw new MetafactureException(e);
} finally {
closeParser();
}
});
}

private List<String> matches(Object obj) {
final List<?> records = (obj instanceof List<?>) ? ((List<?>) obj) : Arrays.asList(obj);
return records.stream().map(doc -> {
try {
return new ObjectMapper().writeValueAsString(doc);
} catch (JsonProcessingException e) {
e.printStackTrace();
return doc.toString();
}
}).collect(Collectors.toList());
}

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,22 @@ public void testShouldProcessConcatenatedRecords() {
ordered.verify(receiver).endRecord();
}

@Test
public void testShouldProcessRecordsInArray() {
jsonDecoder.setRecordPath("$.data");
jsonDecoder.process(
"{\"data\":[" + "{\"lit\": \"record 1\"}," +
"{\"lit\": \"record 2\"}" + "]}");

final InOrder ordered = inOrder(receiver);
ordered.verify(receiver).startRecord("1");
ordered.verify(receiver).literal("lit", "record 1");
ordered.verify(receiver).endRecord();
ordered.verify(receiver).startRecord("2");
ordered.verify(receiver).literal("lit", "record 2");
ordered.verify(receiver).endRecord();
}

@Test
public void testShouldProcessMultipleRecords() {
jsonDecoder.process("{\"lit\": \"record 1\"}");
Expand Down