Skip to content

Commit

Permalink
Introduce Annotation.Builder class and use it to create instances of …
Browse files Browse the repository at this point in the history 
…Annotation class (elastic#56276)
  • Loading branch information
@przemekwitek
przemekwitek committed May 6, 2020
1 parent 5d6c4ed commit d6d36cd
Show file tree
Hide file tree
Showing 8 changed files with 173 additions and 138 deletions.
176 changes: 102 additions & 74 deletions x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/ml/annotations/Annotation.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,42 +30,39 @@ public class Annotation implements ToXContentObject, Writeable {
public static final ParseField MODIFIED_USERNAME = new ParseField("modified_username");
public static final ParseField TYPE = new ParseField("type");

public static final ObjectParser<Annotation, Void> PARSER = new ObjectParser<>(TYPE.getPreferredName(), true, Annotation::new);
public static final ObjectParser<Builder, Void> PARSER = new ObjectParser<>(TYPE.getPreferredName(), true, Builder::new);

static {
PARSER.declareString(Annotation::setAnnotation, ANNOTATION);
PARSER.declareField(Annotation::setCreateTime,
PARSER.declareString(Builder::setAnnotation, ANNOTATION);
PARSER.declareField(Builder::setCreateTime,
p -> TimeUtils.parseTimeField(p, CREATE_TIME.getPreferredName()), CREATE_TIME, ObjectParser.ValueType.VALUE);
PARSER.declareString(Annotation::setCreateUsername, CREATE_USERNAME);
PARSER.declareField(Annotation::setTimestamp,
PARSER.declareString(Builder::setCreateUsername, CREATE_USERNAME);
PARSER.declareField(Builder::setTimestamp,
p -> TimeUtils.parseTimeField(p, TIMESTAMP.getPreferredName()), TIMESTAMP, ObjectParser.ValueType.VALUE);
PARSER.declareField(Annotation::setEndTimestamp,
PARSER.declareField(Builder::setEndTimestamp,
p -> TimeUtils.parseTimeField(p, END_TIMESTAMP.getPreferredName()), END_TIMESTAMP, ObjectParser.ValueType.VALUE);
PARSER.declareString(Annotation::setJobId, Job.ID);
PARSER.declareField(Annotation::setModifiedTime,
PARSER.declareString(Builder::setJobId, Job.ID);
PARSER.declareField(Builder::setModifiedTime,
p -> TimeUtils.parseTimeField(p, MODIFIED_TIME.getPreferredName()), MODIFIED_TIME, ObjectParser.ValueType.VALUE);
PARSER.declareString(Annotation::setModifiedUsername, MODIFIED_USERNAME);
PARSER.declareString(Annotation::setType, TYPE);
PARSER.declareString(Builder::setModifiedUsername, MODIFIED_USERNAME);
PARSER.declareString(Builder::setType, TYPE);
}

private String annotation;
private Date createTime;
private String createUsername;
private Date timestamp;
private Date endTimestamp;
private final String annotation;
private final Date createTime;
private final String createUsername;
private final Date timestamp;
private final Date endTimestamp;
/**
* Unlike most ML classes, this may be <code>null</code> or wildcarded
*/
private String jobId;
private Date modifiedTime;
private String modifiedUsername;
private String type;
private final String jobId;
private final Date modifiedTime;
private final String modifiedUsername;
private final String type;

private Annotation() {
}

public Annotation(String annotation, Date createTime, String createUsername, Date timestamp, Date endTimestamp, String jobId,
Date modifiedTime, String modifiedUsername, String type) {
private Annotation(String annotation, Date createTime, String createUsername, Date timestamp, Date endTimestamp, String jobId,
Date modifiedTime, String modifiedUsername, String type) {
this.annotation = Objects.requireNonNull(annotation);
this.createTime = Objects.requireNonNull(createTime);
this.createUsername = Objects.requireNonNull(createUsername);
Expand All @@ -77,19 +74,6 @@ public Annotation(String annotation, Date createTime, String createUsername, Dat
this.type = Objects.requireNonNull(type);
}

public Annotation(Annotation other) {
Objects.requireNonNull(other);
this.annotation = other.annotation;
this.createTime = new Date(other.createTime.getTime());
this.createUsername = other.createUsername;
this.timestamp = new Date(other.timestamp.getTime());
this.endTimestamp = other.endTimestamp == null ? null : new Date(other.endTimestamp.getTime());
this.jobId = other.jobId;
this.modifiedTime = other.modifiedTime == null ? null : new Date(other.modifiedTime.getTime());
this.modifiedUsername = other.modifiedUsername;
this.type = other.type;
}

public Annotation(StreamInput in) throws IOException {
annotation = in.readString();
createTime = new Date(in.readLong());
Expand Down Expand Up @@ -131,81 +115,44 @@ public void writeTo(StreamOutput out) throws IOException {
}
out.writeOptionalString(modifiedUsername);
out.writeString(type);

}

public String getAnnotation() {
return annotation;
}

public void setAnnotation(String annotation) {
this.annotation = Objects.requireNonNull(annotation);
}

public Date getCreateTime() {
return createTime;
}

public void setCreateTime(Date createTime) {
this.createTime = Objects.requireNonNull(createTime);
}

public String getCreateUsername() {
return createUsername;
}

public void setCreateUsername(String createUsername) {
this.createUsername = Objects.requireNonNull(createUsername);
}

public Date getTimestamp() {
return timestamp;
}

public void setTimestamp(Date timestamp) {
this.timestamp = Objects.requireNonNull(timestamp);
}

public Date getEndTimestamp() {
return endTimestamp;
}

public void setEndTimestamp(Date endTimestamp) {
this.endTimestamp = endTimestamp;
}

public String getJobId() {
return jobId;
}

public void setJobId(String jobId) {
this.jobId = jobId;
}

public Date getModifiedTime() {
return modifiedTime;
}

public void setModifiedTime(Date modifiedTime) {
this.modifiedTime = modifiedTime;
}

public String getModifiedUsername() {
return modifiedUsername;
}

public void setModifiedUsername(String modifiedUsername) {
this.modifiedUsername = modifiedUsername;
}

public String getType() {
return type;
}

public void setType(String type) {
this.type = Objects.requireNonNull(type);
}

@Override
public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
builder.startObject();
Expand Down Expand Up @@ -254,4 +201,85 @@ public boolean equals(Object obj) {
Objects.equals(modifiedUsername, other.modifiedUsername) &&
Objects.equals(type, other.type);
}

public static class Builder {

private String annotation;
private Date createTime;
private String createUsername;
private Date timestamp;
private Date endTimestamp;
/**
* Unlike most ML classes, this may be <code>null</code> or wildcarded
*/
private String jobId;
private Date modifiedTime;
private String modifiedUsername;
private String type;

public Builder() {}

public Builder(Annotation other) {
Objects.requireNonNull(other);
this.annotation = other.annotation;
this.createTime = new Date(other.createTime.getTime());
this.createUsername = other.createUsername;
this.timestamp = new Date(other.timestamp.getTime());
this.endTimestamp = other.endTimestamp == null ? null : new Date(other.endTimestamp.getTime());
this.jobId = other.jobId;
this.modifiedTime = other.modifiedTime == null ? null : new Date(other.modifiedTime.getTime());
this.modifiedUsername = other.modifiedUsername;
this.type = other.type;
}

public Builder setAnnotation(String annotation) {
this.annotation = Objects.requireNonNull(annotation);
return this;
}

public Builder setCreateTime(Date createTime) {
this.createTime = Objects.requireNonNull(createTime);
return this;
}

public Builder setCreateUsername(String createUsername) {
this.createUsername = Objects.requireNonNull(createUsername);
return this;
}

public Builder setTimestamp(Date timestamp) {
this.timestamp = Objects.requireNonNull(timestamp);
return this;
}

public Builder setEndTimestamp(Date endTimestamp) {
this.endTimestamp = endTimestamp;
return this;
}

public Builder setJobId(String jobId) {
this.jobId = jobId;
return this;
}

public Builder setModifiedTime(Date modifiedTime) {
this.modifiedTime = modifiedTime;
return this;
}

public Builder setModifiedUsername(String modifiedUsername) {
this.modifiedUsername = modifiedUsername;
return this;
}

public Builder setType(String type) {
this.type = Objects.requireNonNull(type);
return this;
}

public Annotation build() {
return new Annotation(
annotation, createTime, createUsername, timestamp, endTimestamp, jobId, modifiedTime, modifiedUsername, type);
}
}
}
2 changes: 1 addition & 1 deletion ...e/src/test/java/org/elasticsearch/xpack/core/ml/annotations/AnnotationPersisterTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ private static <T> ActionFuture<T> instantFuture(T response) {

private Annotation parseAnnotation(BytesReference source) throws IOException {
try (XContentParser parser = createParser(jsonXContent, source)) {
return Annotation.PARSER.parse(parser, null);
return Annotation.PARSER.parse(parser, null).build();
}
}
}
24 changes: 13 additions & 11 deletions ...lugin/core/src/test/java/org/elasticsearch/xpack/core/ml/annotations/AnnotationTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ public class AnnotationTests extends AbstractSerializingTestCase<Annotation> {

@Override
protected Annotation doParseInstance(XContentParser parser) {
return Annotation.PARSER.apply(parser, null);
return Annotation.PARSER.apply(parser, null).build();
}

@Override
Expand All @@ -26,15 +26,17 @@ protected Annotation createTestInstance() {
}

static Annotation randomAnnotation() {
return new Annotation(randomAlphaOfLengthBetween(100, 1000),
new Date(randomNonNegativeLong()),
randomAlphaOfLengthBetween(5, 20),
new Date(randomNonNegativeLong()),
randomBoolean() ? new Date(randomNonNegativeLong()) : null,
randomBoolean() ? randomAlphaOfLengthBetween(10, 30) : null,
randomBoolean() ? new Date(randomNonNegativeLong()) : null,
randomBoolean() ? randomAlphaOfLengthBetween(5, 20) : null,
randomAlphaOfLengthBetween(10, 15));
return new Annotation.Builder()
.setAnnotation(randomAlphaOfLengthBetween(100, 1000))
.setCreateTime(new Date(randomNonNegativeLong()))
.setCreateUsername(randomAlphaOfLengthBetween(5, 20))
.setTimestamp(new Date(randomNonNegativeLong()))
.setEndTimestamp(randomBoolean() ? new Date(randomNonNegativeLong()) : null)
.setJobId(randomBoolean() ? randomAlphaOfLengthBetween(10, 30) : null)
.setModifiedTime(randomBoolean() ? new Date(randomNonNegativeLong()) : null)
.setModifiedUsername(randomBoolean() ? randomAlphaOfLengthBetween(5, 20) : null)
.setType(randomAlphaOfLengthBetween(10, 15))
.build();
}

@Override
Expand All @@ -45,7 +47,7 @@ protected Writeable.Reader<Annotation> instanceReader() {
public void testCopyConstructor() {
for (int i = 0; i < NUMBER_OF_TEST_RUNS; i++) {
Annotation testAnnotation = createTestInstance();
assertThat(testAnnotation, equalTo(new Annotation(testAnnotation)));
assertThat(testAnnotation, equalTo(new Annotation.Builder(testAnnotation).build()));
}
}
}
35 changes: 18 additions & 17 deletions x-pack/plugin/ml/src/main/java/org/elasticsearch/xpack/ml/datafeed/DatafeedJob.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -243,26 +243,27 @@ private void checkForMissingDataIfNecessary() {

private Annotation createDelayedDataAnnotation(Date startTime, Date endTime, String msg) {
Date currentTime = new Date(currentTimeSupplier.get());
return new Annotation(
msg,
currentTime,
XPackUser.NAME,
startTime,
endTime,
jobId,
currentTime,
XPackUser.NAME,
"annotation");
return new Annotation.Builder()
.setAnnotation(msg)
.setCreateTime(currentTime)
.setCreateUsername(XPackUser.NAME)
.setTimestamp(startTime)
.setEndTimestamp(endTime)
.setJobId(jobId)
.setModifiedTime(currentTime)
.setModifiedUsername(XPackUser.NAME)
.setType("annotation")
.build();
}

private Annotation updateAnnotation(Annotation annotation) {
Annotation updatedAnnotation = new Annotation(lastDataCheckAnnotationWithId.v2());
updatedAnnotation.setModifiedUsername(XPackUser.NAME);
updatedAnnotation.setModifiedTime(new Date(currentTimeSupplier.get()));
updatedAnnotation.setAnnotation(annotation.getAnnotation());
updatedAnnotation.setTimestamp(annotation.getTimestamp());
updatedAnnotation.setEndTimestamp(annotation.getEndTimestamp());
return updatedAnnotation;
return new Annotation.Builder(lastDataCheckAnnotationWithId.v2())
.setAnnotation(annotation.getAnnotation())
.setTimestamp(annotation.getTimestamp())
.setEndTimestamp(annotation.getEndTimestamp())
.setModifiedTime(new Date(currentTimeSupplier.get()))
.setModifiedUsername(XPackUser.NAME)
.build();
}

/**
Expand Down
21 changes: 11 additions & 10 deletions ...a/org/elasticsearch/xpack/ml/job/process/autodetect/output/AutodetectResultProcessor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -328,16 +328,17 @@ void processResult(AutodetectResult result) {
private Annotation createModelSnapshotAnnotation(ModelSnapshot modelSnapshot) {
assert modelSnapshot != null;
Date currentTime = new Date(clock.millis());
return new Annotation(
Messages.getMessage(Messages.JOB_AUDIT_SNAPSHOT_STORED, modelSnapshot.getSnapshotId()),
currentTime,
XPackUser.NAME,
modelSnapshot.getLatestResultTimeStamp(),
modelSnapshot.getLatestResultTimeStamp(),
jobId,
currentTime,
XPackUser.NAME,
"annotation");
return new Annotation.Builder()
.setAnnotation(Messages.getMessage(Messages.JOB_AUDIT_SNAPSHOT_STORED, modelSnapshot.getSnapshotId()))
.setCreateTime(currentTime)
.setCreateUsername(XPackUser.NAME)
.setTimestamp(modelSnapshot.getLatestResultTimeStamp())
.setEndTimestamp(modelSnapshot.getLatestResultTimeStamp())
.setJobId(jobId)
.setModifiedTime(currentTime)
.setModifiedUsername(XPackUser.NAME)
.setType("annotation")
.build();
}

private void processModelSizeStats(ModelSizeStats modelSizeStats) {
Expand Down
Loading

0 comments on commit d6d36cd

Please sign in to comment.