Skip to content

Optionally escape Unicode in MarcXmlEncoder. #710

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 1 commit into from
Sep 26, 2025
Merged

Optionally escape Unicode in MarcXmlEncoder. #710

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 15 additions & 1 deletion 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 @@ -185,6 +185,15 @@ public void setFormatted(final boolean formatted) {
encoder.setFormatted(formatted);
}

/**
* Flags whether to escape Unicode.
*
* @param escapeUnicode true if Unicode should be escaped
*/
public void setEscapeUnicode(final boolean escapeUnicode) {
encoder.setEscapeUnicode(escapeUnicode);
}

@Override
public void startRecord(final String identifier) {
pipe.startRecord(identifier);
Expand Down Expand Up @@ -242,6 +251,7 @@ private static class Encoder extends DefaultStreamPipe<ObjectReceiver<String>> {
private Object[] namespacePrefix = new Object[]{NAMESPACE_PREFIX};

private int indentationLevel;
private boolean escapeUnicode;
private boolean formatted = PRETTY_PRINTED;
private int recordAttributeOffset;
private int recordLeaderOffset;
Expand Down Expand Up @@ -270,6 +280,10 @@ public void setFormatted(final boolean formatted) {
this.formatted = formatted;
}

public void setEscapeUnicode(final boolean escapeUnicode) {
this.escapeUnicode = escapeUnicode;
}

@Override
public void startRecord(final String identifier) {
if (atStreamStart) {
Expand Down Expand Up @@ -434,7 +448,7 @@ private boolean appendLeader(final String name, final String value) {
* @param str the unescaped sequence to be written
*/
private void writeEscaped(final String str) {
builder.append(XmlUtil.escape(str, false));
builder.append(XmlUtil.escape(str, escapeUnicode));
}

private void writeLeader() {
Expand Down
30 changes: 30 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 @@ -46,6 +46,9 @@ public class MarcXmlEncoderTest {
private static final String XML_MARC_COLLECTION_END_TAG = "</marc:collection>";
private static final String RECORD_ID = "92005291";

private static final int UNICODE_CODE_POINT = 1048576;
private static final String UNICODE_STRING = Character.toString(UNICODE_CODE_POINT);

private StringBuilder resultCollector;
private int resultCollectorsResetStreamCount;
private MarcXmlEncoder encoder;
Expand Down Expand Up @@ -171,6 +174,33 @@ public void createARecordWithEscapedSequences() {
Assert.assertEquals(expected, actual);
}

@Test
public void createARecordWithoutEscapedUnicode() {
encoder.startRecord(RECORD_ID);
encoder.literal("001", UNICODE_STRING);
encoder.endRecord();
encoder.onResetStream();
final String expected = XML_DECLARATION + XML_ROOT_OPEN + "<marc:record>" +
"<marc:controlfield tag=\"001\">\000</marc:controlfield>" + "</marc:record>" +
XML_MARC_COLLECTION_END_TAG;
final String actual = resultCollector.toString();
Assert.assertEquals(expected, actual);
}

@Test
public void createARecordWithEscapedUnicode() {
encoder.setEscapeUnicode(true);
encoder.startRecord(RECORD_ID);
encoder.literal("001", UNICODE_STRING);
encoder.endRecord();
encoder.onResetStream();
final String expected = XML_DECLARATION + XML_ROOT_OPEN + "<marc:record>" +
"<marc:controlfield tag=\"001\">&#" + UNICODE_CODE_POINT + ";</marc:controlfield>" + "</marc:record>" +
XML_MARC_COLLECTION_END_TAG;
final String actual = resultCollector.toString();
Assert.assertEquals(expected, actual);
}

@Test
public void createTwoRecordsInOneCollection() {
addOneRecord();
Expand Down