com.ontotext.s4.model.annotation.Annotation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of s4-client Show documentation

The Self-Service Semantic Suite (S4) provides a set of services for low-cost, on-demand text analytics and metadata management in the cloud.

The newest version!

/*
 * S4 Java client library
 * Copyright 2016 Ontotext AD
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.ontotext.s4.model.annotation;

import java.util.HashMap;
import java.util.Map;

import com.fasterxml.jackson.annotation.JsonAnySetter;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * Representation of a single annotation from an annotated document returned by the S4 online API.
 */
public class Annotation {

    /**
     * Start offset of the annotation (a zero-based index into the
     * containing document's {@link AnnotatedDocument#text plain text}).
     */
    private long startOffset;

    /**
     * End offset of the annotation (a zero-based index into the
     * containing document's {@link AnnotatedDocument#text plain text}).
     */
    private long endOffset;

    /**
     * The annotation's features.
     */
    private Map features = new HashMap<>();

    public Annotation() {

    }

    public Annotation(long startOffset, long endOffset, Map features) {
        this.startOffset = startOffset;
        this.endOffset = endOffset;
        this.features = features;
    }


    public long getStartOffset() {
        return this.startOffset;
    }
    public void setStartOffset(long startOffset) {
        this.startOffset = startOffset;
    }

    public long getEndOffset() {
        return this.endOffset;
    }
    public void setEndOffset(long endOffset) {
        this.endOffset = endOffset;
    }

    public Map getFeatures() {
        return this.features;
    }
    public void setFeatures(Map features) {
        this.features = features;
    }

    /**
     * Used by Jackson to decode the "indices" property of the JSON response into start and end offsets.
     *
     * @param indices a two-element array containing the start and end offsets, in that order.
     */
    @JsonCreator
    public Annotation(@JsonProperty("indices") long[] indices) {
        startOffset = indices[0];
        endOffset = indices[1];
    }

    /**
     * Catch-all setter used by Jackson to gather other properties
     * from the JSON response into the {@link #features} map.
     *
     * @param name The name of the feature
     * @param value The value of the feature
     */
    @JsonAnySetter
    public void addFeature(String name, Object value) {
        features.put(name, value);
    }

}