public class DocImageHandler extends Object implements IXMLConfigurable
Handles images associated with a document (which is different than a document being itself an image). Examples can be screenshots, featured image, etc. Images can be stored in a document metadata/field or in a local directory.
<targets>[metadata|directory] (One or both, separated by comma.)</targets>
<imageFormat>(Image format. Default is "png".)</imageFormat>
<!-- The following applies to the "directory" target: -->
<targetDir
field="(Document field to store the local path to the image.)"
structure="[url2path|date|datetime]">
(Local directory where to save images.)
</targetDir>
<!-- The following applies to the "metadata" target: -->
<targetMetaField>(Document field where to store the image.)</targetMetaField>
The above XML configurable options can be nested in a parent tag of any name. The expected parent tag name is defined by the consuming classes.
Modifier and Type | Class and Description |
---|---|
static class |
DocImageHandler.DirStructure |
static class |
DocImageHandler.Target |
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_IMAGE_FORMAT |
protected static List<DocImageHandler.Target> |
DEFAULT_TYPES |
Constructor and Description |
---|
DocImageHandler() |
DocImageHandler(Path defaultDir,
String defaultDirField,
String defaultMetaField) |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object other) |
String |
getImageFormat() |
Path |
getTargetDir() |
String |
getTargetDirField() |
DocImageHandler.DirStructure |
getTargetDirStructure() |
String |
getTargetMetaField() |
List<DocImageHandler.Target> |
getTargets() |
void |
handleImage(InputStream imageStream,
Doc doc) |
int |
hashCode() |
void |
loadFromXML(XML xml) |
void |
saveToXML(XML xml) |
void |
setImageFormat(String imageFormat) |
void |
setTargetDir(Path diskDir) |
void |
setTargetDirField(String diskField) |
void |
setTargetDirStructure(DocImageHandler.DirStructure dirStructure) |
void |
setTargetMetaField(String metadataField) |
void |
setTargets(DocImageHandler.Target... targets) |
void |
setTargets(List<DocImageHandler.Target> targets) |
String |
toString() |
public static final String DEFAULT_IMAGE_FORMAT
protected static final List<DocImageHandler.Target> DEFAULT_TYPES
public DocImageHandler(Path defaultDir, String defaultDirField, String defaultMetaField)
public DocImageHandler()
public Path getTargetDir()
public void setTargetDir(Path diskDir)
public String getTargetDirField()
public void setTargetDirField(String diskField)
public DocImageHandler.DirStructure getTargetDirStructure()
public void setTargetDirStructure(DocImageHandler.DirStructure dirStructure)
public String getTargetMetaField()
public void setTargetMetaField(String metadataField)
public List<DocImageHandler.Target> getTargets()
public void setTargets(DocImageHandler.Target... targets)
public void setTargets(List<DocImageHandler.Target> targets)
public String getImageFormat()
public void setImageFormat(String imageFormat)
public void handleImage(InputStream imageStream, Doc doc)
public void loadFromXML(XML xml)
loadFromXML
in interface IXMLConfigurable
public void saveToXML(XML xml)
saveToXML
in interface IXMLConfigurable
Copyright © 2009–2023 Norconex Inc.. All rights reserved.