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

Allow flushing collectors to only emit when complete. #332

Merged
merged 1 commit into from
Sep 15, 2020
Merged

Allow flushing collectors to only emit when complete. #332

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
8 changes: 7 additions & 1 deletion ...orph-api/src/main/java/org/metafacture/metamorph/api/helpers/AbstractFlushingCollect.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,16 @@
*/
public abstract class AbstractFlushingCollect extends AbstractCollect {

private boolean flushIncomplete = true;

public final void setFlushIncomplete(final boolean flushIncomplete) {
this.flushIncomplete = flushIncomplete;
}

@Override
public final void flush(final int recordCount, final int entityCount) {
if (isSameRecord(recordCount) && sameEntityConstraintSatisfied(entityCount)) {
if(isConditionMet()) {
if(isConditionMet() && (flushIncomplete || isComplete())) {
emit();
}
if (getReset()) {
Expand Down
6 changes: 6 additions & 0 deletions metamorph/src/main/resources/schemata/metamorph.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,8 @@
<attribute name="name" type="string" use="required" />
<attribute name="value" type="string" use="required" />

<attribute name="flushIncomplete" type="boolean" use="optional"
default="true" />
<attribute name="reset" type="boolean" use="optional"
default="false" />
<attribute name="sameEntity" type="boolean" use="optional"
Expand All @@ -301,6 +303,8 @@
<attribute name="name" type="string" use="required" />
<attribute name="value" type="string" use="required" />

<attribute name="flushIncomplete" type="boolean" use="optional"
default="true" />
<attribute name="reset" type="boolean" use="optional"
default="false" />
<attribute name="sameEntity" type="boolean" use="optional"
Expand Down Expand Up @@ -442,6 +446,8 @@
have an entity-name element otherwise an empty name is emitted</documentation>
</annotation>
</attribute>
<attribute name="flushIncomplete" type="boolean" use="optional"
default="true" />
<attribute name="reset" type="boolean" use="optional"
default="false" />
<attribute name="sameEntity" type="boolean" use="optional"
Expand Down
33 changes: 33 additions & 0 deletions metamorph/src/test/java/org/metafacture/metamorph/collectors/CombineTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
package org.metafacture.metamorph.collectors;

import static org.mockito.Mockito.inOrder;
import static org.mockito.Mockito.verifyNoMoreInteractions;

import org.junit.Rule;
import org.junit.Test;
Expand Down Expand Up @@ -165,6 +166,38 @@ public void shouldEmitCurrentValueOnFlushEvent() {
ordered.verifyNoMoreInteractions();
}

@Test
public void shouldNotEmitCurrentValueOnFlushEventIfIncomplete() {
metamorph = InlineMorph.in(this)
.with("<rules>")
.with(" <combine name='combi' value='${one}${two}' flushWith='e' flushIncomplete='false' reset='true'>")
.with(" <data source='e.l' name='one' />")
.with(" <data source='e.m' name='two' />")
.with(" </combine>")
.with("</rules>")
.createConnectedTo(receiver);

metamorph.startRecord("1");
metamorph.startEntity("e");
metamorph.literal("l", "1");
metamorph.endEntity();
metamorph.startEntity("e");
metamorph.literal("l", "2");
metamorph.literal("m", "2");
metamorph.endEntity();
metamorph.startEntity("e");
metamorph.literal("l", "3");
metamorph.endEntity();
metamorph.endRecord();

final InOrder ordered = inOrder(receiver);
ordered.verify(receiver).startRecord("1");
ordered.verify(receiver).literal("combi", "22");
ordered.verify(receiver).endRecord();
ordered.verifyNoMoreInteractions();
verifyNoMoreInteractions(receiver);
}

@Test
public void shouldPostprocessCombinedValue() {
metamorph = InlineMorph.in(this)
Expand Down
37 changes: 36 additions & 1 deletion metamorph/src/test/java/org/metafacture/metamorph/collectors/EntityTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

import static org.mockito.Mockito.inOrder;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verifyNoMoreInteractions;

import org.junit.Rule;
import org.junit.Test;
Expand Down Expand Up @@ -119,6 +120,40 @@ public void shouldEmitEnityOnFlushEvent() {
ordered.verifyNoMoreInteractions();
}

@Test
public void shouldNotEmitEnityOnFlushEventIfIncomplete() {
metamorph = InlineMorph.in(this)
.with("<rules>")
.with(" <entity name='entity' flushWith='record' flushIncomplete='false'>")
.with(" <data source='d1' name='l1' />")
.with(" <data source='d2' name='l2' />")
.with(" </entity>")
.with("</rules>")
.createConnectedTo(receiver);

metamorph.startRecord("1");
metamorph.literal("d1", "a");
metamorph.literal("d1", "b");
metamorph.literal("d2", "c");
metamorph.endRecord();
metamorph.startRecord("2");
metamorph.literal("d2", "c");
metamorph.endRecord();

final InOrder ordered = inOrder(receiver);
ordered.verify(receiver).startRecord("1");
ordered.verify(receiver).startEntity("entity");
ordered.verify(receiver).literal("l1", "a");
ordered.verify(receiver).literal("l1", "b");
ordered.verify(receiver).literal("l2", "c");
ordered.verify(receiver).endEntity();
ordered.verify(receiver).endRecord();
ordered.verify(receiver).startRecord("2");
ordered.verify(receiver).endRecord();
ordered.verifyNoMoreInteractions();
verifyNoMoreInteractions(receiver);
}

@Test
public void shouldEmitEntityOnEachFlushEvent() {
metamorph = InlineMorph.in(this)
Expand Down Expand Up @@ -488,7 +523,7 @@ public void shouldEmitEntityContentsAgainIfResetIsFalse() {
}

@Test
public void shouldNotEmitEntityContentsAgainIfResetIsFalse() {
public void shouldNotEmitEntityContentsAgainIfResetIsTrue() {
metamorph = InlineMorph.in(this)
.with("<rules>")
.with(" <entity name='entity' reset='true'>")
Expand Down
82 changes: 82 additions & 0 deletions metamorph/src/test/java/org/metafacture/metamorph/collectors/EqualsFilterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.inOrder;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.verifyNoMoreInteractions;

import org.junit.Rule;
import org.junit.Test;
Expand Down Expand Up @@ -233,4 +234,85 @@ public void shouldFireIfLiteralsInEntitiesAreReceivedThatAreNotListedInStatement
ordered.verifyNoMoreInteractions();
}

@Test
public void shouldFireOnFlush() {
metamorph = InlineMorph.in(this)
.with("<rules>")
.with(" <equalsFilter name='equalsFiltered' value='${one}' flushWith='field1.data2'>")
.with(" <data source='field1.data1' name='one' />")
.with(" <data source='field1.data2' name='two' />")
.with(" </equalsFilter>")
.with("</rules>")
.createConnectedTo(receiver);

metamorph.startRecord("1");
metamorph.startEntity("field1");
metamorph.literal("data1", "a");
metamorph.endEntity();
metamorph.endRecord();
metamorph.startRecord("2");
metamorph.startEntity("field1");
metamorph.literal("data2", "a");
metamorph.endEntity();
metamorph.endRecord();
metamorph.startRecord("3");
metamorph.startEntity("field1");
metamorph.literal("data1", "a");
metamorph.literal("data2", "a");
metamorph.endEntity();
metamorph.endRecord();

final InOrder ordered = inOrder(receiver);
ordered.verify(receiver).startRecord("1");
ordered.verify(receiver).endRecord();
ordered.verify(receiver).startRecord("2");
ordered.verify(receiver).literal("equalsFiltered", "");
ordered.verify(receiver).endRecord();
ordered.verify(receiver).startRecord("3");
ordered.verify(receiver).literal("equalsFiltered", "a");
ordered.verify(receiver).endRecord();
ordered.verifyNoMoreInteractions();
verifyNoMoreInteractions(receiver);
}

@Test
public void shouldNotFireOnFlushIfIncomplete() {
metamorph = InlineMorph.in(this)
.with("<rules>")
.with(" <equalsFilter name='equalsFiltered' value='${one}' flushWith='field1.data2' flushIncomplete='false'>")
.with(" <data source='field1.data1' name='one' />")
.with(" <data source='field1.data2' name='two' />")
.with(" </equalsFilter>")
.with("</rules>")
.createConnectedTo(receiver);

metamorph.startRecord("1");
metamorph.startEntity("field1");
metamorph.literal("data1", "a");
metamorph.endEntity();
metamorph.endRecord();
metamorph.startRecord("2");
metamorph.startEntity("field1");
metamorph.literal("data2", "a");
metamorph.endEntity();
metamorph.endRecord();
metamorph.startRecord("3");
metamorph.startEntity("field1");
metamorph.literal("data1", "a");
metamorph.literal("data2", "a");
metamorph.endEntity();
metamorph.endRecord();

final InOrder ordered = inOrder(receiver);
ordered.verify(receiver).startRecord("1");
ordered.verify(receiver).endRecord();
ordered.verify(receiver).startRecord("2");
ordered.verify(receiver).endRecord();
ordered.verify(receiver).startRecord("3");
ordered.verify(receiver).literal("equalsFiltered", "a");
ordered.verify(receiver).endRecord();
ordered.verifyNoMoreInteractions();
verifyNoMoreInteractions(receiver);
}

}