Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/**********************************************************************************************
*
* Asprise Scanning and Imaging API - http://asprise.com/document-scanner-image-pdf/java-scanning-api-overview.html
* Copyright (C) 1998-2018. Asprise Inc.
*
* This file is licensed under the GNU Affero General Public License version 3 as published by
* the Free Software Foundation.
*
* 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.
*
* You should have received a copy of the GNU Affero General Public License. If not, please
* visit .
*
**********************************************************************************************/
package com.asprise.imaging.core;
import com.asprise.imaging.core.scan.twain.TwainConstants;
import com.asprise.imaging.core.scan.twain.TwainUtil;
import com.asprise.imaging.core.util.system.StringUtils;
import com.asprise.imaging.core.util.system.Utils;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* Represents an image scanned.
*/
public class ResultImageItem {
/** List of barcodes recognized on the image. */
private List> barcodes = new ArrayList>();
/** Caps returned */
private Map caps = new HashMap();
/** Extended image attributes */
private Map extendedImageAttrs = new HashMap();
/** Image info if available. */
private ImageInfo imageInfo;
/** Image layout if available */
private ImageLayout imageLayout;
private Date acquiredOn;
/** Whether it is blank */
private Boolean blank;
/** Ink coverage */
private double inkCoverage = -1;
private String customProps;
protected ResultImageItem(Map jsonImageObject) {
barcodes = (List>) jsonImageObject.get("barcodes");
caps = (Map) jsonImageObject.get("caps");
extendedImageAttrs = (Map) jsonImageObject.get("extended_image_attrs");
imageInfo = ImageInfo.createImageInfo((Map) jsonImageObject.get("image_info"));
imageLayout = ImageLayout.createImageLayout((Map) jsonImageObject.get("image_layout"));
long acquired = TwainUtil.toLong(jsonImageObject.get("time"), 0);
acquiredOn = acquired == 0 ? null : new Date(acquired * 1000);
blank = jsonImageObject.containsKey("is_blank") ? jsonImageObject.get("is_blank").toString().equalsIgnoreCase("true") : null;
inkCoverage = TwainUtil.toDouble(jsonImageObject.get("ink_coverage"), -1);
customProps = (String) jsonImageObject.get("custom_props");
}
public Map toJsonObject() {
Map json = new HashMap();
json.put("barcodes", barcodes);
json.put("caps", caps);
json.put("extended_image_attrs", extendedImageAttrs);
if(imageInfo != null) {
json.put("image_info", imageInfo.toJsonObject());
}
if(imageLayout != null) {
json.put("image_layout", imageLayout.toJsonObject());
}
json.put("time", acquiredOn == null ? null : acquiredOn.getTime());
if(blank != null) {
json.put("is_blank", blank);
}
if(inkCoverage >= 0) {
json.put("ink_coverage", inkCoverage);
}
if(customProps != null) {
json.put("custom_props", customProps);
}
return json;
}
/**
* Returns 'NEW', 'NEW_SEP' or null.
* @return
*/
public String getDocNewSepAsString() {
Map map = StringUtils.propertiesStringToMap(customProps, "|", "=", true);
return map.get("DOC");
}
/**
* Whether this image marks a new document from the next image.
* @return
*/
public boolean isDocNewSeparator() {
Map map = StringUtils.propertiesStringToMap(customProps, "|", "=", true);
return "NEW_SEP".equalsIgnoreCase(map.get("DOC"));
}
/**
* Whether this image marks a new document with it as a first page.
* @return
*/
public boolean isDocNew() {
Map map = StringUtils.propertiesStringToMap(customProps, "|", "=", true);
return Request.SEP_MARKER_NEW.equalsIgnoreCase(map.get("DOC"));
}
/**
* Mark or unmark new doc.
* @param docNew whether marks a new document
* @param isSeparator whether this image should be included in the new doc
*/
public void setDocNew(boolean docNew, boolean isSeparator) {
Map map = StringUtils.propertiesStringToMap(customProps, "|", "=", true);
if(docNew) {
map.put("DOC", isSeparator ? Request.SEP_MARKER_NEW_SEP : Request.SEP_MARKER_NEW);
} else {
map.remove("DOC");
}
customProps = StringUtils.propertiesMapToString(map, "|", "=");
}
/**
* Creates ScanResultImageItem if the jsonImageObject is not null.
* @param jsonImageObject
* @return ScanResultImageItem created or null if jsonImageObject is null.
*/
public static ResultImageItem createScanResultImageItem(Map jsonImageObject) {
if(jsonImageObject == null) {
return null;
} else {
return new ResultImageItem(jsonImageObject);
}
}
/**
* Caps in key(cap name)-value map.
* @return
*/
public Map getCaps() {
return caps;
}
/**
* Retrieves the value of the given cap.
* @param capCode
* @return the cap value or null if cap hasn't been retrieved.
*/
public String getCap(int capCode) {
if(caps == null) {
return null;
}
String capName = TwainConstants.getCapName(capCode);
Object value = caps.get(capName);
return value == null ? null : value.toString();
}
/**
* Extended image attributes in key(extended image attribute name)-value map.
* @return
*/
public Map getExtendedImageAttrs() {
return extendedImageAttrs;
}
/**
* Return value "0", ... "5", or null if unsupported.
* @return
*/
public String getTweiPatchcode() {
String value = extendedImageAttrs == null ? null : String.valueOf(extendedImageAttrs.get("TWEI_PATCHCODE"));
if("UNSUPPORTED".equalsIgnoreCase(value)) {
return null;
}
return value;
}
/**
* Return value "0", ... "5", or null if unsupported.
* @return
*/
public String getTweiValue(String tweiName) {
String value = extendedImageAttrs == null ? null : String.valueOf(extendedImageAttrs.get(tweiName));
if("UNSUPPORTED".equalsIgnoreCase(value)) {
return null;
}
return value;
}
/**
* Returns the value of {@linkplain TwainConstants#TWEI_BARCODETEXT} or null if unsupported.
* @return
*/
public String getTweiBarcodeText() {
String value = extendedImageAttrs == null ? null : String.valueOf(extendedImageAttrs.get("TWEI_BARCODETEXT"));
if("UNSUPPORTED".equalsIgnoreCase(value)) {
return null;
}
return value;
}
/**
* Retrieves the value of the given attribute.
* @param attrCode
* @return the attribute value or null if it hasn't been retrieved.
*/
public String getExtendedImageAttr(int attrCode) {
if(extendedImageAttrs == null) {
return null;
}
String tweiName = TwainConstants.getTweiName(attrCode);
Object value = extendedImageAttrs.get(tweiName);
return value == null ? null : value.toString();
}
/**
* Image info if available.
* @return
*/
public ImageInfo getImageInfo() {
return imageInfo;
}
/**
* Gets the image resolution in x direction.
* @return the image resolution or -1 if not available.
*/
public int getImageInfoResolution() {
return imageInfo == null ? -1 : imageInfo.XResolution;
}
/**
* Gets the image width.
* @return the image width or -1 if not available.
*/
public int getImageInfoWidth() {
return imageInfo == null ? -1 : imageInfo.ImageWidth;
}
/**
* Gets the image height.
* @return the image height or -1 not available.
*/
public int getImageInfoHeight() {
return imageInfo == null ? -1 : imageInfo.ImageLength;
}
/**
* Gets pixel type.
* @return -1 if not available or any of {@linkplain TwainConstants#TWPT_BW}, {@linkplain TwainConstants#TWPT_GRAY}, {@linkplain TwainConstants#TWPT_RGB}.
*/
public int getImageInfoPixelType() {
return imageInfo == null ? -1 : imageInfo.PixelType;
}
/**
* Gets the bit depth (bits per pixel).
* @return -1 if not available or the actual bit depth.
*/
public int getImageInfoBitDepth() {
return imageInfo == null ? -1 : imageInfo.BitsPerPixel;
}
/**
* Image layout if available.
* @return
*/
public ImageLayout getImageLayout() {
return imageLayout;
}
/**
* Gets the document number.
* @return the document number or -1 if not available.
*/
public int getImageLayoutDocumentNumber() {
return imageLayout == null ? -1 : imageLayout.DocumentNumber;
}
/**
* Gets the frame number.
* @return the frame number or -1 if not available.
*/
public int getImageLayoutFrameNumber() {
return imageLayout == null ? -1 : imageLayout.FrameNumber;
}
/**
* Gets the page number.
* @return the page number or -1 if not available.
*/
public int getImageLayoutPageNumber() {
return imageLayout == null ? -1 : imageLayout.PageNumber;
}
/**
* Gets the frame location (left, top, right, bottom) in unit {@linkplain TwainConstants#ICAP_UNITS}.
* @return the frame location (4-element double array) or null if not available.
*/
public double[] getImageLayoutFrame() {
return imageLayout == null ? null : imageLayout.Frame;
}
/**
* The acquisition time or null if not available.
* @return
*/
public Date getAcquiredOn() {
return acquiredOn;
}
/**
* List of barcodes recognized on the image.
* @return barcodes recognized or empty list if recognition is not performed or none is recognized.
*/
public List> getBarcodes() {
return barcodes;
}
/** Whether it is blank - available only if blank page detection is enabled. */
public boolean isBlank() {
return blank != null && blank;
}
/**
* Ink coverage - available only if blank page detection is enabled.
* @return ink coverage or negative value if it is not available.
*/
public double getInkCoverage() {
return inkCoverage;
}
/**
* Corresponding to TWAIN's TW_IMAGEINFO struct
*/
public static class ImageInfo {
/** Impacted by cap: ICAP_XRESOLUTION */
public int XResolution = -1;
/** Impacted by cap: ICAP_YRESOLUTION */
public int YResolution = -1;
/** Impacted by cap: TW_IMAGELAYOUT.TW_FRAME.Right - TW_FRAME.Left */
public int ImageWidth = -1;
/** Impacted by cap: TW_IMAGELAYOUT.TW_FRAME.Bottom - TW_FRAME.Top */
public int ImageLength = -1;
/** Impacted by cap: ICAP_PIXELTYPE (i.e. TWPT_BW has 1, TWPT_RGB has 3) */
public int SamplesPerPixel = -1;
/** Calculated by BitsPerPixel divided by SamplesPerPixel. */
public int[] BitsPerSample;
/** Impacted by cap: ICAP_BITDEPTH */
public int BitsPerPixel = -1;
/** Impacted by cap: ICAP_PLANARCHUNKY */
public Boolean Planar = false;
/** Impacted by cap: ICAP_PIXELTYPE */
public int PixelType = -1;
/** Impacted by cap: ICAP_COMPRESSION */
public int Compression = -1;
public ImageInfo(Map valueMap) {
this.XResolution = TwainUtil.toInteger(valueMap.get("XResolution"), -1);
this.YResolution = TwainUtil.toInteger(valueMap.get("YResolution"), -1);
this.ImageWidth = TwainUtil.toInteger(valueMap.get("ImageWidth"), -1);
this.ImageLength = TwainUtil.toInteger(valueMap.get("ImageLength"), -1);
this.SamplesPerPixel = TwainUtil.toInteger(valueMap.get("SamplesPerPixel"), -1);
this.BitsPerPixel = TwainUtil.toInteger(valueMap.get("BitsPerPixel"), -1);
this.Planar = valueMap.get("Planar") == null ? null : TwainUtil.toInteger(valueMap.get("Planar"), 0) != 0;
this.PixelType = TwainUtil.toInteger(valueMap.get("PixelType"), -1);
this.Compression = TwainUtil.toInteger(valueMap.get("Compression"), -1);
}
public Map toJsonObject() {
Map json = new HashMap();
if(XResolution >= 0) {
json.put("XResolution", XResolution);
}
if(YResolution >= 0) {
json.put("YResolution", YResolution);
}
if(ImageWidth >= 0) {
json.put("ImageWidth", ImageWidth);
}
if(ImageLength >= 0) {
json.put("ImageLength", ImageLength);
}
if(SamplesPerPixel >= 0) {
json.put("SamplesPerPixel", SamplesPerPixel);
}
if(BitsPerPixel >= 0) {
json.put("BitsPerPixel", BitsPerPixel);
}
if(Planar != null) {
json.put("Planar", Planar);
}
if(PixelType >= 0) {
json.put("PixelType", PixelType);
}
if(Compression >= 0) {
json.put("Compression", Compression);
}
return json;
}
public ImageInfo() {
}
/**
* Creates ImageInfo if the valueMap is not null.
* @param valueMap
* @return ImageInfo created or null if valueMap is null.
*/
public static ImageInfo createImageInfo(Map valueMap) {
if(valueMap == null) {
return null;
} else {
return new ImageInfo(valueMap);
}
}
@Override
public String toString() {
return "ImageInfo{" +
"XResolution=" + XResolution +
", YResolution=" + YResolution +
", ImageWidth=" + ImageWidth +
", ImageLength=" + ImageLength +
", SamplesPerPixel=" + SamplesPerPixel +
", BitsPerSample=" + Arrays.toString(BitsPerSample) +
", BitsPerPixel=" + BitsPerPixel +
", Planar=" + Planar +
", PixelType=" + PixelType +
", Compression=" + Compression +
'}';
}
}
/**
* Corresponding to TWAIN's TW_IMAGELAYOUT struct
*/
public static class ImageLayout {
public double[] Frame;
public int DocumentNumber = -1;
public int PageNumber = -1;
public int FrameNumber = -1;
public ImageLayout(Map valueMap) {
this.DocumentNumber = TwainUtil.toInteger(valueMap.get("DocumentNumber"), -1);
this.PageNumber = TwainUtil.toInteger(valueMap.get("PageNumber"), -1);
this.FrameNumber = TwainUtil.toInteger(valueMap.get("FrameNumber"), -1);
this.Frame = TwainUtil.parseFrame(String.valueOf(valueMap.get("Frame")));
}
public Map toJsonObject() {
Map json = new HashMap();
if(DocumentNumber >= 0) {
json.put("DocumentNumber", DocumentNumber);
}
if(PageNumber >= 0) {
json.put("PageNumber", PageNumber);
}
if(FrameNumber >= 0) {
json.put("FrameNumber", FrameNumber);
}
if(Frame != null && Frame.length == 4) {
json.put("Frame", "(" + Frame[0] + ", " + Frame[1] + ", " + Frame[2] + ", " + Frame[3] + ")");
}
return json;
}
public ImageLayout() {
}
/**
* Creates ImageLayout if the valueMap is not null.
* @param valueMap
* @return ImageLayout created or null if valueMap is null.
*/
public static ImageLayout createImageLayout(Map valueMap) {
if(valueMap == null) {
return null;
} else {
return new ImageLayout(valueMap);
}
}
@Override
public String toString() {
return "ImageLayout{" +
"Frame=" + Arrays.toString(Frame) +
", DocumentNumber=" + DocumentNumber +
", PageNumber=" + PageNumber +
", FrameNumber=" + FrameNumber +
'}';
}
}
}
