com.basistech.rosette.dm.LayoutRegion Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of adm-model Show documentation
ADM data model.
There is a newer version: 3.0.6
/*
 * Copyright 2019 Basis Technology Corp.
 *
 * 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.basistech.rosette.dm;


import com.google.common.base.MoreObjects;
import lombok.EqualsAndHashCode;

import java.io.Serializable;
import java.util.Map;

/**
 * Layout defines text as spans defined by structured or unstructured regions.
 */
@EqualsAndHashCode(callSuper = true)
public class LayoutRegion extends Attribute implements Serializable {

    /**
     * Layout types
     */
    public enum Layout {
        /**
         * For unstructured text.
         */
        UNSTRUCTURED,
        /**
         * For structured text, such as lists or tables.
         */
        STRUCTURED,
    }

    private static final long serialVersionUID = 270L;
    private final Layout layout;

    protected LayoutRegion(int startOffset, int endOffset, Layout layout, Map extendedProperties) {
        super(startOffset, endOffset, extendedProperties);
        this.layout = layout;
    }

    /**
     * Gets the layout.
     * @return the layout
     */
    public Layout getLayout() {
        return layout;
    }

    @Override
    protected MoreObjects.ToStringHelper toStringHelper() {
        return super.toStringHelper()
                .add("layout", layout);
    }

    /**
     * Builder for layout regions.
     */
    public static class Builder extends Attribute.Builder {
        private Layout layout;

        /**
         * Constructs a layout region builder from the required values.
         *
         * @param startOffset the start offset in characters
         * @param endOffset the end offset in characters
         * @param layout the layout type
         */
        public Builder(int startOffset, int endOffset, Layout layout) {
            super(startOffset, endOffset);
            this.layout = layout;
        }

        /**
         * Constructs a builder from an existing layout region.
         *
         * @param toCopy the object to copy
         */
        public Builder(LayoutRegion toCopy) {
            super(toCopy);
            this.layout = toCopy.layout;
        }

        /**
         * Builds an immutable layout region from the current state of this builder.
         *
         * @return the new region
         */
        public LayoutRegion build() {
            return new LayoutRegion(startOffset, endOffset, layout, buildExtendedProperties());
        }

        @Override
        protected LayoutRegion.Builder getThis() {
            return this;
        }
    }
}