Package com.norconex.crawler.web.doc.operations.image.impl

Class FeaturedImageResolverConfig

java.lang.Object

com.norconex.crawler.web.doc.operations.image.impl.FeaturedImageResolverConfig

public class FeaturedImageResolverConfig
extends Object

Configuration for FeaturedImageResolver.

Since:

2.8.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FeaturedImageResolverConfig.Quality
static enum	FeaturedImageResolverConfig.Storage	Type of featured image storages.
static enum	FeaturedImageResolverConfig.StorageDiskStructure	Directory structure when storing images on disk.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_IMAGE_CACHE_SIZE
static final String	DEFAULT_IMAGE_FORMAT
static final Dimension	DEFAULT_MIN_SIZE
static final String	DEFAULT_PAGE_CONTENT_TYPE_PATTERN
static final Dimension	DEFAULT_SCALE_SIZE
static final FeaturedImageResolverConfig.Storage	DEFAULT_STORAGE
static final String	DEFAULT_STORAGE_DISK_DIR	Default featured image directory, relative to the crawler working directory.
static final FeaturedImageResolverConfig.StorageDiskStructure	DEFAULT_STORAGE_DISK_STRUCTURE
static final String	FEATURED_IMAGE_INLINE_FIELD
static final String	FEATURED_IMAGE_PATH_FIELD
static final String	FEATURED_IMAGE_URL_FIELD

Constructor Summary

Constructors

Constructor	Description
FeaturedImageResolverConfig()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getDomSelector()	Optional CSS-like path matching one or more image elements.
int	getImageCacheSize()	Maximum number of images to cache in memory for faster processing.
String	getImageFormat()	Target format of stored image.
Dimension	getMinDimensions()	Minimum pixel size for an image to be considered.
String	getPageContentTypePattern()	Optional regex to overwrite default matching of HTML pages.
Dimension	getScaleDimensions()	Target pixel size the featured image should be scaled to.
FeaturedImageResolverConfig.Quality	getScaleQuality()	Desired scaling quality.
Path	getStorageDiskDir()	Path to directory where to store images on disk.
String	getStorageDiskField()	Name of metadata field where to store the local path to an image.
FeaturedImageResolverConfig.StorageDiskStructure	getStorageDiskStructure()	The type of directory structure to create when one of the values of of getStorages() is FeaturedImageResolverConfig.Storage.DISK.
String	getStorageInlineField()	Name of metadata field where to store the Base64 image.
List<FeaturedImageResolverConfig.Storage>	getStorages()	Gets the storages mechanisms.
String	getStorageUrlField()	Name of metadata field where to store the remote image URL.
int	hashCode()
boolean	isLargest()	When more than one featured image is found, whether to return the largest of them all (as opposed to the first one encountered).
boolean	isScaleStretch()	Whether to stretch to match scale size.
FeaturedImageResolverConfig	setDomSelector(String domSelector)	Optional CSS-like path matching one or more image elements.
FeaturedImageResolverConfig	setImageCacheSize(int imageCacheSize)	Maximum number of images to cache in memory for faster processing.
FeaturedImageResolverConfig	setImageFormat(String imageFormat)	Target format of stored image.
FeaturedImageResolverConfig	setLargest(boolean largest)	When more than one featured image is found, whether to return the largest of them all (as opposed to the first one encountered).
FeaturedImageResolverConfig	setMinDimensions(Dimension minDimensions)	Minimum pixel size for an image to be considered.
FeaturedImageResolverConfig	setPageContentTypePattern(String pageContentTypePattern)	Optional regex to overwrite default matching of HTML pages.
FeaturedImageResolverConfig	setScaleDimensions(Dimension scaleDimensions)	Target pixel size the featured image should be scaled to.
FeaturedImageResolverConfig	setScaleQuality(FeaturedImageResolverConfig.Quality scaleQuality)	Desired scaling quality.
FeaturedImageResolverConfig	setScaleStretch(boolean scaleStretch)	Whether to stretch to match scale size.
FeaturedImageResolverConfig	setStorageDiskDir(Path storageDiskDir)	Path to directory where to store images on disk.
FeaturedImageResolverConfig	setStorageDiskField(String storageDiskField)	Name of metadata field where to store the local path to an image.
FeaturedImageResolverConfig	setStorageDiskStructure(FeaturedImageResolverConfig.StorageDiskStructure storageDiskStructure)	The type of directory structure to create when one of the values of of getStorages() is FeaturedImageResolverConfig.Storage.DISK.
FeaturedImageResolverConfig	setStorageInlineField(String storageInlineField)	Name of metadata field where to store the Base64 image.
FeaturedImageResolverConfig	setStorages(List<FeaturedImageResolverConfig.Storage> storages)	Sets the storages mechanisms.
FeaturedImageResolverConfig	setStorageUrlField(String storageUrlField)	Name of metadata field where to store the remote image URL.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

FEATURED_IMAGE_URL_FIELD

public static final String FEATURED_IMAGE_URL_FIELD

See Also:

• Constant Field Values

FEATURED_IMAGE_PATH_FIELD

public static final String FEATURED_IMAGE_PATH_FIELD

See Also:

• Constant Field Values

FEATURED_IMAGE_INLINE_FIELD

public static final String FEATURED_IMAGE_INLINE_FIELD

See Also:

• Constant Field Values

DEFAULT_PAGE_CONTENT_TYPE_PATTERN

public static final String DEFAULT_PAGE_CONTENT_TYPE_PATTERN

See Also:

• Constant Field Values

DEFAULT_IMAGE_CACHE_SIZE

public static final int DEFAULT_IMAGE_CACHE_SIZE

See Also:

• Constant Field Values

DEFAULT_STORAGE_DISK_DIR

public static final String DEFAULT_STORAGE_DISK_DIR

Default featured image directory, relative to the crawler working directory.

See Also:

• Constant Field Values

DEFAULT_IMAGE_FORMAT

public static final String DEFAULT_IMAGE_FORMAT

See Also:

• Constant Field Values

DEFAULT_MIN_SIZE

public static final Dimension DEFAULT_MIN_SIZE

DEFAULT_SCALE_SIZE

public static final Dimension DEFAULT_SCALE_SIZE

DEFAULT_STORAGE

public static final FeaturedImageResolverConfig.Storage DEFAULT_STORAGE

DEFAULT_STORAGE_DISK_STRUCTURE

public static final FeaturedImageResolverConfig.StorageDiskStructure DEFAULT_STORAGE_DISK_STRUCTURE

Constructor Details

FeaturedImageResolverConfig

public FeaturedImageResolverConfig()

Method Details

getStorages

public List<FeaturedImageResolverConfig.Storage> getStorages()

Gets the storages mechanisms.

Returns:

storages mechanisms

setStorages

public FeaturedImageResolverConfig setStorages(List<FeaturedImageResolverConfig.Storage> storages)

Sets the storages mechanisms.

Parameters:

storages - storages mechanisms

Returns:

this

getPageContentTypePattern

public String getPageContentTypePattern()

Optional regex to overwrite default matching of HTML pages. Default is "text/html|application/(xhtml\\+xml|vnd\\.wap.xhtml\\+xml|x-asp)"

getDomSelector

public String getDomSelector()

Optional CSS-like path matching one or more image elements.

getMinDimensions

public Dimension getMinDimensions()

Minimum pixel size for an image to be considered. Default is 400x400.

getScaleDimensions

public Dimension getScaleDimensions()

Target pixel size the featured image should be scaled to. Default is 150x150.

isScaleStretch

public boolean isScaleStretch()

Whether to stretch to match scale size. Default keeps aspect ratio.

getImageFormat

public String getImageFormat()

Target format of stored image. E.g., "jpg", "png", "gif", "bmp", ... Default is "png"

getImageCacheSize

public int getImageCacheSize()

Maximum number of images to cache in memory for faster processing. The cache prevents re-downloading and re-scaling the same image when it appears on multiple pages. Set to 0 to disable caching. Default is 200.

isLargest

public boolean isLargest()

When more than one featured image is found, whether to return the largest of them all (as opposed to the first one encountered).

getStorageDiskDir

public Path getStorageDiskDir()

Path to directory where to store images on disk. Only applicable when one of the values of getStorages() is FeaturedImageResolverConfig.Storage.DISK.

getStorageDiskStructure

public FeaturedImageResolverConfig.StorageDiskStructure getStorageDiskStructure()

The type of directory structure to create when one of the values of of getStorages() is FeaturedImageResolverConfig.Storage.DISK.

getScaleQuality

public FeaturedImageResolverConfig.Quality getScaleQuality()

Desired scaling quality. Default is FeaturedImageResolverConfig.Quality.AUTO, which tries the best balance between quality and speed based on image size. The lower the quality the faster it is to scale images.

getStorageDiskField

public String getStorageDiskField()

Name of metadata field where to store the local path to an image. Only applicable if one of the getStorages() values is FeaturedImageResolverConfig.Storage.DISK. Default is "crawler.featured-image-path"

getStorageInlineField

public String getStorageInlineField()

Name of metadata field where to store the Base64 image. Only applicable if one of the getStorages() values is FeaturedImageResolverConfig.Storage.INLINE. Default is "crawler.featured-image-inline"

getStorageUrlField

public String getStorageUrlField()

Name of metadata field where to store the remote image URL. Only applicable if one of the getStorages() values is FeaturedImageResolverConfig.Storage.URL. Default is "crawler.featured-image-url"

setPageContentTypePattern

public FeaturedImageResolverConfig setPageContentTypePattern(String pageContentTypePattern)

Optional regex to overwrite default matching of HTML pages. Default is "text/html|application/(xhtml\\+xml|vnd\\.wap.xhtml\\+xml|x-asp)"

Returns:

this.

setDomSelector

public FeaturedImageResolverConfig setDomSelector(String domSelector)

Optional CSS-like path matching one or more image elements.

Returns:

this.

setMinDimensions

public FeaturedImageResolverConfig setMinDimensions(Dimension minDimensions)

Minimum pixel size for an image to be considered. Default is 400x400.

Returns:

this.

setScaleDimensions

public FeaturedImageResolverConfig setScaleDimensions(Dimension scaleDimensions)

Target pixel size the featured image should be scaled to. Default is 150x150.

Returns:

this.

setScaleStretch

public FeaturedImageResolverConfig setScaleStretch(boolean scaleStretch)

Whether to stretch to match scale size. Default keeps aspect ratio.

Returns:

this.

setImageFormat

public FeaturedImageResolverConfig setImageFormat(String imageFormat)

Target format of stored image. E.g., "jpg", "png", "gif", "bmp", ... Default is "png"

Returns:

this.

setImageCacheSize

public FeaturedImageResolverConfig setImageCacheSize(int imageCacheSize)

Maximum number of images to cache in memory for faster processing. The cache prevents re-downloading and re-scaling the same image when it appears on multiple pages. Set to 0 to disable caching. Default is 200.

Returns:

this.

setLargest

public FeaturedImageResolverConfig setLargest(boolean largest)

When more than one featured image is found, whether to return the largest of them all (as opposed to the first one encountered).

Returns:

this.

setStorageDiskDir

public FeaturedImageResolverConfig setStorageDiskDir(Path storageDiskDir)

Path to directory where to store images on disk. Only applicable when one of the values of getStorages() is FeaturedImageResolverConfig.Storage.DISK.

Returns:

this.

setStorageDiskStructure

public FeaturedImageResolverConfig setStorageDiskStructure(FeaturedImageResolverConfig.StorageDiskStructure storageDiskStructure)

The type of directory structure to create when one of the values of of getStorages() is FeaturedImageResolverConfig.Storage.DISK.

Returns:

this.

setScaleQuality

public FeaturedImageResolverConfig setScaleQuality(FeaturedImageResolverConfig.Quality scaleQuality)

Desired scaling quality. Default is FeaturedImageResolverConfig.Quality.AUTO, which tries the best balance between quality and speed based on image size. The lower the quality the faster it is to scale images.

Returns:

this.

setStorageDiskField

public FeaturedImageResolverConfig setStorageDiskField(String storageDiskField)

Name of metadata field where to store the local path to an image. Only applicable if one of the getStorages() values is FeaturedImageResolverConfig.Storage.DISK. Default is "crawler.featured-image-path"

Returns:

this.

setStorageInlineField

public FeaturedImageResolverConfig setStorageInlineField(String storageInlineField)

Name of metadata field where to store the Base64 image. Only applicable if one of the getStorages() values is FeaturedImageResolverConfig.Storage.INLINE. Default is "crawler.featured-image-inline"

Returns:

this.

setStorageUrlField

public FeaturedImageResolverConfig setStorageUrlField(String storageUrlField)

Name of metadata field where to store the remote image URL. Only applicable if one of the getStorages() values is FeaturedImageResolverConfig.Storage.URL. Default is "crawler.featured-image-url"

Returns:

this.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object