* An {@link com.arsdigita.cms.Asset asset} representing an image. An ImageAsset is deleted when its * parent content item is deleted and is not intended to be reused between content items..
* * @see com.arsdigita.cms.ReusableImageAsset * @see com.arsdigita.cms.BinaryAsset * * @author Jack Chung * @author Stanislav Freidin * @author Sören BernsteinDataObject is retrieved from the persistent storage
* mechanism with an OID specified by oid.
*
* @param oid The OID for the retrieved DataObject.
*/
public ImageAsset(OID oid) throws DataObjectNotFoundException {
super(oid);
}
/**
* Constructor. The contained DataObject is retrieved from the persistent storage
* mechanism with an OID specified by id and
* ImageAsset.BASE_DATA_OBJECT_TYPE.
*
* @param id The id for the retrieved DataObject.
*
*/
public ImageAsset(BigDecimal id) throws DataObjectNotFoundException {
this(new OID(BASE_DATA_OBJECT_TYPE, id));
}
public ImageAsset(DataObject obj) {
super(obj);
}
public ImageAsset(String type) {
super(type);
}
/**
* @return the base PDL object type for this item. Child classes should override this method to
* return the correct value
*/
@Override
public String getBaseDataObjectType() {
return BASE_DATA_OBJECT_TYPE;
}
public BigDecimal getWidth() {
return (BigDecimal) get(WIDTH);
}
public void setWidth(BigDecimal width) {
set(WIDTH, width);
}
public BigDecimal getHeight() {
return (BigDecimal) get(HEIGHT);
}
public void setHeight(BigDecimal height) {
set(HEIGHT, height);
}
/**
* Retrieves the Blob content.
*
* @return the Blob content
*/
@Override
protected byte[] getContent() {
return (byte[]) get(CONTENT);
}
/**
* Sets the Blob content.
*/
@Override
protected void setContent(byte[] content) {
set(CONTENT, content);
}
/**
* Load the image asset from the specified file. Automatically guesses the mime type of the
* file. If the file is a jpeg, tries to automatically determine width and height, as well.
*
* @param fileName The original name of the file
* @param file The actual file on the server
* @param defaultMimeType The default mime type for the file (ignored)
*/
public void loadFromFile(String fileName, File file, String defaultMimeType)
throws IOException, IllegalArgumentException {
BufferedImage image;
if (file == null) {
throw new IllegalArgumentException("Parameter file must not be null.");
}
try {
image = ImageIO.read(file);
} catch (IOException ex) {
throw new IOException("Can't read image format.");
}
// Guess mime type
MimeType mime = MimeType.guessMimeTypeFromFile(fileName);
if (mime == null && !(mime instanceof ImageMimeType)) {
throw new IOException("Unsupported image format.");
}
setMimeType(mime);
// Image size
readImageSize(image);
// Extract filename
setName(extractFilename(fileName));
// Create InputStream
FileInputStream in = new FileInputStream(file);
// Save image data
readBytes(in);
}
/**
* Write the image asset content to a file.
*
* @param file The file on the server to write to.
*/
@Override
public void writeToFile(File file)
throws IOException {
FileOutputStream fs = new FileOutputStream(file);
try {
fs.write(getContent());
} finally {
if (null != fs) {
fs.close();
}
}
}
/**
* Retrieve all images in the database. Extremely expensive !
*
* @return a collection of ImageAssets
*/
public static ImageAssetCollection getAllImages() {
DataCollection da = SessionManager.getSession().retrieve(BASE_DATA_OBJECT_TYPE);
da.addEqualsFilter(VersionedACSObject.IS_DELETED, new Integer(0));
return new ImageAssetCollection(da);
}
/**
* Find all images whose name matches the specified keyword
*
* @param keyword a String keyword
* @param context the context for the retrieved items. Should be {@link ContentItem#DRAFT} or
* {@link ContentItem#LIVE}
*
* @return a collection of images whose name matches the keyword
*/
public static ImageAssetCollection getImagesByKeyword(
String keyword, String context) {
ImageAssetCollection c = getAllImages();
c.addOrder(Asset.NAME);
Filter f;
f = c.addFilter("name like (\'%\' || :keyword || \'%\')");
f.set("keyword", keyword);
f = c.addFilter("version = :version");
f.set("version", context);
return c;
}
/**
* Find all images whose name matches the specified keyword
*
* @param keyword a String keyword
*
* @return a collection of images whose name matches the keyword
*/
public static ImageAssetCollection getImagesByKeyword(String keyword) {
return getImagesByKeyword(keyword, ContentItem.DRAFT);
}
/**
* Resize this ImageAsset proportional to maxThumbnailWidth, if this ImageAsset is wider then
* maxThumbnailWidth. Else just return this ImageAsset.
*
* @param maxThumbnailWidth max image width
*
* @return
*/
public ImageAsset proportionalResizeToWidth(int maxThumbnailWidth) {
if (this.getWidth().intValue() <= maxThumbnailWidth) {
return this;
} else {
ImageAsset imageAsset = new ImageAsset();
imageAsset.setMimeType(this.getMimeType());
imageAsset.setName("Scaled" + this.getName());
ByteArrayInputStream in = new ByteArrayInputStream(this.getContent());
try {
BufferedImage origImage = ImageIO.read(in);
ByteArrayOutputStream scaledImageBuffer = new ByteArrayOutputStream();
java.awt.Image scaledImage = origImage.getScaledInstance(maxThumbnailWidth, -1,
java.awt.Image.SCALE_SMOOTH);
BufferedImage scaledBufImage = new BufferedImage(scaledImage.getWidth(null),
scaledImage.getHeight(null),
origImage.getType());
scaledBufImage.getGraphics().drawImage(scaledImage, 0, 0, null);
ImageIO.write(scaledBufImage, this.getMimeType().getFileExtension(),
scaledImageBuffer);
imageAsset.setContent(scaledImageBuffer.toByteArray());
imageAsset.setWidth(new BigDecimal(scaledImage.getWidth(null)));
imageAsset.setHeight(new BigDecimal(scaledImage.getHeight(null)));
} catch (IOException e) {
imageAsset.setContent(this.getContent());
imageAsset.setWidth(this.getWidth());
imageAsset.setHeight(this.getHeight());
}
return imageAsset;
}
}
/**
* Extract filename from path
*
* @param fileName
*
* @return filename
*/
protected String extractFilename(String fileName) {
//
// Extract the filename
int i = fileName.lastIndexOf("/");
if (i > 0) {
fileName = fileName.substring(i + 1);
}
i = fileName.lastIndexOf("\\"); // DOS-style
if (i > 0) {
fileName = fileName.substring(i + 1);
}
return fileName;
}
/**
* Read image size from file.
*/
private void readImageSize(BufferedImage image) {
setWidth(new BigDecimal(image.getWidth()));
setHeight(new BigDecimal(image.getHeight()));
}
}