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.

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

Add option 'validateLeader' #572

Merged
merged 1 commit into from
Nov 19, 2024
Merged

Add option 'validateLeader' #572

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
23 changes: 19 additions & 4 deletions metafacture-biblio/src/main/java/org/metafacture/biblio/marc21/Marc21Encoder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ public final class Marc21Encoder extends
private State state = State.IN_STREAM;

private boolean generateIdField;
private boolean validateLeader = true;

/**
* Initializes the encoder with MARC 21 constants and charset.
Expand Down Expand Up @@ -108,6 +109,18 @@ public void setGenerateIdField(final boolean generateIdField) {
this.generateIdField = generateIdField;
}

/**
* Controls whether the leader should be validated.
* <p>
* The default value of {@code validateLeader} is true.
* <p>
*
* @param validateLeader if false the leader is not validated
*/
public void setValidateLeader(final boolean validateLeader) {
this.validateLeader = validateLeader;
}

/**
* Gets the flag to decide whether the ID field is generated.
*
Expand Down Expand Up @@ -259,12 +272,14 @@ private void processLeaderAsSubfields(final String name, final char code) {
}

private void requireValidCode(final char code, final char[] validCodes) {
for (final char validCode: validCodes) {
if (validCode == code) {
return;
if (validateLeader) {
for (final char validCode : validCodes) {
if (validCode == code) {
return;
}
}
throw new FormatException("invalid code '" + code + "'; allowed codes are: " + Arrays.toString(validCodes));
}
throw new FormatException("invalid code '" + code + "'; allowed codes are: " + Arrays.toString(validCodes));
}

private void processTopLevelLiteral(final String name, final String value) {
Expand Down
19 changes: 19 additions & 0 deletions metafacture-biblio/src/test/java/org/metafacture/biblio/marc21/Marc21EncoderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@
*/
public final class Marc21EncoderTest {

private static final String BAD_LEADER = "00600ny a22002053n 4500";

private Marc21Encoder marc21Encoder;

@Mock
Expand Down Expand Up @@ -147,4 +149,21 @@ public void issue524ShouldComputeValidLeader() {
verify(receiver).process(matches("00055pam a2200037 c 4500021001700000\u001e.*\u001d"));
}

@Test(expected = FormatException.class)
public void issue567ShouldFailValidateLeaderAsDefault() {
marc21Encoder.startRecord("");
marc21Encoder.literal(LEADER_ENTITY, BAD_LEADER);
marc21Encoder.endRecord();
}

@Test
public void issue567ShouldNotValidateLeader() {
marc21Encoder.setValidateLeader(false);
marc21Encoder.startRecord("");
marc21Encoder.literal(LEADER_ENTITY, BAD_LEADER );
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra whitespace.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had inserted the extra line on purpose to separate the setting of attributes of the class vs. using the interface feeding the document - but it looks ugly. I've removed now the empty line.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Too bad, it made sense (exactly for the reason you mentioned). I was talking about the extra blanks around BAD_LEADER.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah - good :) This explains why you said "whitespace", not "empty line" - was wondering myself why you were so (uncommonly) imprecise.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 3599947.

marc21Encoder.endRecord();

verify(receiver).process(matches("00026ny a22000253n 4500\u001e\u001d"));
}

}
Loading