io.cloudslang.content.tesseract.utils.Descriptions Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cs-tesseract Show documentation
Show all versions of cs-tesseract Show documentation
OCR Tesseract integration in CloudSlang
/*
* (c) Copyright 2019 Micro Focus, L.P.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Apache License v2.0 which accompany this distribution.
*
* The Apache License is available 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 io.cloudslang.content.tesseract.utils;
public class Descriptions {
public static class Common {
public static final String RETURN_CODE_DESC = "0 if success, -1 otherwise.";
public static final String EXCEPTION_DESC = "In case of success response, this result is empty. In case of " +
"failure response, this result contains the java stack trace of the runtime exception.";
}
public static class ExtractText {
public static final String EXTRACT_TEXT_FROM_IMAGE_DESC = "This operation extracts the text from a specified image given " +
"as input using Tesseract's OCR library.";
public static final String RETURN_RESULT_DESC = "This will contain the extracted text.";
public static final String SUCCESS_DESC = "Text extracted successfully.";
public static final String FAILURE_DESC = "There was an error while trying to extract the text.";
}
public static class InputsDescription {
public static final String FILE_PATH_DESC = "The path to the file from where the text needs to be extracted.";
public static final String DATA_PATH_DESC = "The path to the tessdata folder that contains the tesseract config" +
" files.";
public static final String DATA_PATH_INP_DESC = "The path to a folder where OCR Tesseract configuration files will be created.";
public static final String LANGUAGE_DESC = "The language that will be used by the OCR engine. This input is " +
"taken into consideration only when specifying the dataPath input as well.";
public static final String PDF_FILE_PATH_DESC = "The path to the PDF file from where the text needs to be " +
"extracted.";
public static final String DPI_DESC = "The DPI value when converting the PDF file to image.";
public static final String TEXT_BLOCKS_DESC = "If set to 'true' operation will return a json containing text blocks " +
"extracted from image. Valid values: false, true" +
"Default value: false";
public static final String DESKEW_DESC = "Improve text recognition if an image does not have a normal text" +
" orientation(skewed image). If set to 'true' the image will be rotated to the correct text " +
"orientation.\nValid values: false, true\n" +
"Default value: false";
public static final String FROM_PAGE_DESC = "The starting page from where the text should be retrieved";
public static final String TO_PAGE_DESC = "The last page from where the text should be retrieved";
public static final String PAGE_INDEX_DESC = "A list of indexes from where the text should be retrieved";
}
public static class OutputsDescription {
public static final String TEXT_STRING_DESC = "The extracted text from image.";
public static final String TEXT_JSON_DESC = "A json containing extracted blocks of text from image.";
}
public static class ExtractTextFromPDF {
public static final String EXTRACT_TEXT_FROM_PDF_DESC = "This operation converts a PDF file given " +
"as input and extracts the text using Tesseract's OCR library.";
}
public static class TesseractSetup {
public static final String TESSERACT_SETUP_DESC = "This operation setup Tesseract config files.";
public static final String CONFIGURATION_FILES_FOR_TESSERACT_OCR = "Configuration files for Tesseract OCR created successfully.";
public static final String SUCCESS_SETUP_DESC = "Configuration files created successfully.";
public static final String FAILURE_SETUP_DESC = "There was an error while trying to create configuration files.";
}
}