Skip to content

Make emitting MARCXML namespace configurable. #410

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 27, 2021
Merged

Make emitting MARCXML namespace configurable. #410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
21c84fa
Make emitting MARCXML namespace configurable.
blackwinter Oct 15, 2021
ef9bbb1
Simplify MARCXML tag definition.
blackwinter Oct 18, 2021
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
88 changes: 64 additions & 24 deletions metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/MarcXmlEncoder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@
import org.metafacture.framework.annotations.Out;
import org.metafacture.framework.helpers.DefaultStreamPipe;

import java.util.Arrays;
import java.util.Collections;
import java.util.function.Function;

/**
* Encodes a stream into MARCXML.
Expand All @@ -40,28 +42,48 @@
@FluxCommand("encode-marcxml")
public final class MarcXmlEncoder extends DefaultStreamPipe<ObjectReceiver<String>> {

private static final String ROOT_OPEN = "<marc:collection xmlns:marc=\"http://www.loc.gov/MARC21/slim\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:schemaLocation=\"http://www.loc.gov/MARC21/slim http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd\">";
private static final String ROOT_CLOSE = "</marc:collection>";
private enum Tag {

private static final String RECORD_OPEN = "<marc:record>";
private static final String RECORD_CLOSE = "</marc:record>";
collection(" xmlns%s=\"" + NAMESPACE + "\"%s"),
controlfield(" tag=\"%s\""),
datafield(" tag=\"%s\" ind1=\"%s\" ind2=\"%s\""),
leader(""),
record(""),
subfield(" code=\"%s\"");

private static final String ATTRIBUTE_TEMPLATE = " %s=\"%s\"";
private static final String OPEN_TEMPLATE = "<%%s%s%s>";
private static final String CLOSE_TEMPLATE = "</%%s%s>";

private final String openTemplate;
private final String closeTemplate;

Tag(final String template) {
openTemplate = String.format(OPEN_TEMPLATE, name(), template);
closeTemplate = String.format(CLOSE_TEMPLATE, name());
}

public String open(final Object[] args) {
return String.format(openTemplate, args);
}

public String close(final Object[] args) {
return String.format(closeTemplate, args);
}

private static final String CONTROLFIELD_OPEN_TEMPLATE = "<marc:controlfield tag=\"%s\">";
private static final String CONTROLFIELD_CLOSE = "</marc:controlfield>";
}

private static final String DATAFIELD_OPEN_TEMPLATE = "<marc:datafield tag=\"%s\" ind1=\"%s\" ind2=\"%s\">";
private static final String DATAFIELD_CLOSE = "</marc:datafield>";
private static final String NAMESPACE = "http://www.loc.gov/MARC21/slim";
private static final String NAMESPACE_NAME = "marc";
private static final String NAMESPACE_PREFIX = NAMESPACE_NAME + ":";
private static final String NAMESPACE_SUFFIX = ":" + NAMESPACE_NAME;

private static final String SUBFIELD_OPEN_TEMPLATE = "<marc:subfield code=\"%s\">";
private static final String SUBFIELD_CLOSE = "</marc:subfield>";
private static final String SCHEMA_ATTRIBUTES = " xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:schemaLocation=\"" + NAMESPACE + " http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd\"";

private static final String LEADER_OPEN_TEMPLATE = "<marc:leader>";
private static final String LEADER_CLOSE_TEMPLATE = "</marc:leader>";
private static final String ATTRIBUTE_TEMPLATE = " %s=\"%s\"";

private static final String NEW_LINE = "\n";
private static final String INDENT = "\t";
private static final String EMPTY = "";

private static final String XML_DECLARATION_TEMPLATE = "<?xml version=\"%s\" encoding=\"%s\"?>";

Expand All @@ -82,6 +104,9 @@ public final class MarcXmlEncoder extends DefaultStreamPipe<ObjectReceiver<Strin
private String xmlVersion;
private String xmlEncoding;

private boolean emitNamespace;
private Object[] namespacePrefix;

private String currentEntity;
private int indentationLevel;
private int recordAttributeOffset;
Expand All @@ -99,6 +124,13 @@ public MarcXmlEncoder() {

this.indentationLevel = 0;
this.formatted = true;

setEmitNamespace(true);
}

public void setEmitNamespace(final boolean emitNamespace) {
this.emitNamespace = emitNamespace;
namespacePrefix = new Object[]{emitNamespace ? NAMESPACE_PREFIX : EMPTY};
}

public void omitXmlDeclaration(final boolean currentOmitXmlDeclaration) {
Expand Down Expand Up @@ -130,14 +162,14 @@ public void startRecord(final String identifier) {
writeHeader();
prettyPrintNewLine();
}
writeRaw(ROOT_OPEN);
writeTag(Tag.collection::open, emitNamespace ? NAMESPACE_SUFFIX : EMPTY, emitNamespace ? SCHEMA_ATTRIBUTES : EMPTY);
prettyPrintNewLine();
incrementIndentationLevel();
}
atStreamStart = false;

prettyPrintIndentation();
writeRaw(RECORD_OPEN);
writeTag(Tag.record::open);
recordAttributeOffset = builder.length() - 1;
prettyPrintNewLine();

Expand All @@ -148,7 +180,7 @@ public void startRecord(final String identifier) {
public void endRecord() {
decrementIndentationLevel();
prettyPrintIndentation();
writeRaw(RECORD_CLOSE);
writeTag(Tag.record::close);
prettyPrintNewLine();
sendAndClearData();
}
Expand All @@ -167,7 +199,7 @@ public void startEntity(final String name) {
final String ind1 = name.substring(IND1_BEGIN, IND1_END);
final String ind2 = name.substring(IND2_BEGIN, IND2_END);
prettyPrintIndentation();
writeRaw(String.format(DATAFIELD_OPEN_TEMPLATE, tag, ind1, ind2));
writeTag(Tag.datafield::open, tag, ind1, ind2);
prettyPrintNewLine();
incrementIndentationLevel();
}
Expand All @@ -178,7 +210,7 @@ public void endEntity() {
if (!currentEntity.equals(Marc21EventNames.LEADER_ENTITY)) {
decrementIndentationLevel();
prettyPrintIndentation();
writeRaw(DATAFIELD_CLOSE);
writeTag(Tag.datafield::close);
prettyPrintNewLine();
}
currentEntity = "";
Expand All @@ -194,19 +226,19 @@ public void literal(final String name, final String value) {
}
else if (!writeLeader(name, value)) {
prettyPrintIndentation();
writeRaw(String.format(CONTROLFIELD_OPEN_TEMPLATE, name));
writeTag(Tag.controlfield::open, name);
if (value != null) {
writeEscaped(value.trim());
}
writeRaw(CONTROLFIELD_CLOSE);
writeTag(Tag.controlfield::close);
prettyPrintNewLine();
}
}
else if (!writeLeader(currentEntity, value)) {
prettyPrintIndentation();
writeRaw(String.format(SUBFIELD_OPEN_TEMPLATE, name));
writeTag(Tag.subfield::open, name);
writeEscaped(value.trim());
writeRaw(SUBFIELD_CLOSE);
writeTag(Tag.subfield::close);
prettyPrintNewLine();
}
}
Expand Down Expand Up @@ -243,7 +275,7 @@ private void writeHeader() {

/** Closes the root tag */
private void writeFooter() {
writeRaw(ROOT_CLOSE);
writeTag(Tag.collection::close);
}

/** Writes a unescaped sequence */
Expand All @@ -259,7 +291,9 @@ private void writeEscaped(final String str) {
private boolean writeLeader(final String name, final String value) {
if (name.equals(Marc21EventNames.LEADER_ENTITY)) {
prettyPrintIndentation();
writeRaw(LEADER_OPEN_TEMPLATE + value + LEADER_CLOSE_TEMPLATE);
writeTag(Tag.leader::open);
writeRaw(value);
writeTag(Tag.leader::close);
prettyPrintNewLine();

return true;
Expand All @@ -269,6 +303,12 @@ private boolean writeLeader(final String name, final String value) {
}
}

private void writeTag(final Function<Object[], String> function, final Object... args) {
final Object[] allArgs = Arrays.copyOf(namespacePrefix, namespacePrefix.length + args.length);
System.arraycopy(args, 0, allArgs, namespacePrefix.length, args.length);
writeRaw(function.apply(allArgs));
}

private void prettyPrintIndentation() {
if (formatted) {
final String prefix = String.join("", Collections.nCopies(indentationLevel, INDENT));
Expand Down
12 changes: 12 additions & 0 deletions metafacture-biblio/src/test/java/org/metafacture/biblio/marc21/MarcXmlEncoderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,18 @@ public void createTwoRecordsInOneCollection() {
assertEquals(expected, actual);
}

@Test
public void issue403_shouldNotEmitNamespaceIfDisabled() {
encoder.setEmitNamespace(false);
addOneRecord(encoder);
addOneRecord(encoder);
encoder.closeStream();
String expected = XML_DECLARATION + "<collection xmlns=\"http://www.loc.gov/MARC21/slim\">"
+ XML_RECORD + XML_RECORD + XML_MARC_COLLECTION_END_TAG;
String actual = resultCollector.toString();
assertEquals(expected.replace("marc:", ""), actual);
}

@Test(expected = MetafactureException.class)
public void emitExceptionWhenEntityLengthNot5() {
encoder.startRecord(RECORD_ID);
Expand Down