com.formkiq.vision.crafter.PageScratchPad Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2018 FormKiQ Inc.
 *
 * 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.formkiq.vision.crafter;

import java.util.List;

import com.formkiq.vision.document.DocumentSource;

/**
 * Class for holding {@link DocumentSource} Page Information.
 *
 */
public class PageScratchPad {

    /** {@link DocumentSource}. */
    private DocumentSource document;
	/** Document Page Number. */
	private Integer documentPageNumber;
	/** {@link List} {@link DocumentWall}. */
	private List pageWalls;
	/** {@link List} {@link TextLineExtractor}. */
	private List pageLines;

	/**
	 * constructor.
	 * @param source {@link DocumentSource}
	 * @param pageNumber {@link Integer}
	 */
    public PageScratchPad(final DocumentSource source,
            final Integer pageNumber) {
	    this.document = source;
		this.documentPageNumber = pageNumber;
	}

	/**
	 * @return {@link List} {@link DocumentWall}
	 */
	public List getPageWalls() {
		return this.pageWalls;
	}

	/**
	 * @param walls {@link List} {@link DocumentWall}
	 */
	public void setPageWalls(final List walls) {
		this.pageWalls = walls;
	}

	/**
	 * @return {@link List} {@link TextLineExtractor}
	 */
	public List getPageLines() {
		return this.pageLines;
	}

	/**
	 * @param lines {@link List} {@link TextLineExtractor}
	 */
	public void setPageLines(final List lines) {
		this.pageLines = lines;
	}

	/**
	 * @return {@link Integer}
	 */
	public Integer getDocumentPageNumber() {
		return this.documentPageNumber;
	}

    /**
     * @return {@link DocumentSource}
     */
    public DocumentSource getDocument() {
        return this.document;
    }
}