com.arsdigita.cms
Class ReusableImageAsset

java.lang.Object
  extended bycom.arsdigita.domain.DomainObject
      extended bycom.arsdigita.domain.ObservableDomainObject
          extended bycom.arsdigita.kernel.ACSObject
              extended bycom.arsdigita.versioning.VersionedACSObject
                  extended bycom.arsdigita.cms.ContentItem
                      extended bycom.arsdigita.cms.Asset
                          extended bycom.arsdigita.cms.BinaryAsset
                              extended bycom.arsdigita.cms.ImageAsset
                                  extended bycom.arsdigita.cms.ReusableImageAsset
All Implemented Interfaces:
com.arsdigita.auditing.Audited, CustomCopy

public class ReusableImageAsset
extends ImageAsset

An asset representing a reusable image.

Version:
$Revision: #11 $ $DateTime: 2004/05/07 10:44:03 $
Author:
Scott Seago (sseago@redhat.com), Stanislav Freidin
See Also:
ImageAsset

Field Summary
static String BASE_DATA_OBJECT_TYPE
           
static String versionId
           
 
Fields inherited from class com.arsdigita.cms.ImageAsset
CONTENT, HEIGHT, MIME_GIF, MIME_JPEG, WIDTH
 
Fields inherited from class com.arsdigita.cms.Asset
DESCRIPTION, MIME_TYPE, NAME
 
Fields inherited from class com.arsdigita.cms.ContentItem
ANCESTORS, AUDITING, CHILDREN, CONTENT_SECTION, CONTENT_TYPE, DRAFT, DRAFT_VERSION, LANGUAGE, LIVE, PARENT, PENDING, VERSION, VERSIONS
 
Fields inherited from class com.arsdigita.versioning.VersionedACSObject
IS_DELETED, MASTER
 
Fields inherited from class com.arsdigita.kernel.ACSObject
CONTAINER, DEFAULT_DOMAIN_CLASS, DISPLAY_NAME, ID, OBJECT_TYPE
 
Constructor Summary
ReusableImageAsset()
          Default constructor.
ReusableImageAsset(BigDecimal id)
          Constructor.
ReusableImageAsset(com.arsdigita.persistence.DataObject obj)
           
ReusableImageAsset(com.arsdigita.persistence.OID oid)
          Constructor.
ReusableImageAsset(String type)
           
 
Method Summary
static ImageAssetCollection getAllReusableImages()
          Retrieve all images in the database.
 String getBaseDataObjectType()
           
protected  byte[] getContent()
          Retrieves the Blob content.
 BigDecimal getHeight()
           
static ImageAssetCollection getReusableImagesByKeyword(String keyword)
          Find all images whose name matches the specified keyword
static ImageAssetCollection getReusableImagesByKeyword(String keyword, String context)
          Find all images whose name matches the specified keyword
 BigDecimal getWidth()
           
 void loadFromFile(String fileName, File file, String defaultMimeType)
          Load the image asset from the specified file.
protected  void setContent(byte[] content)
          Sets the Blob content.
 void setHeight(BigDecimal height)
           
 void setWidth(BigDecimal width)
           
 void writeToFile(File file)
          Write the image asset content to a file.
 
Methods inherited from class com.arsdigita.cms.ImageAsset
getAllImages, getImagesByKeyword, getImagesByKeyword, guessSize
 
Methods inherited from class com.arsdigita.cms.BinaryAsset
getSize, readBytes, writeBytes
 
Methods inherited from class com.arsdigita.cms.Asset
getDescription, getMimeType, setDescription, setMimeType
 
Methods inherited from class com.arsdigita.cms.ContentItem
addCategory, addPendingVersion, afterSave, assertDraft, assertLive, assertMaster, assertPending, beforeDelete, beforeSave, canPublishToFS, copy, copy, copyProperty, copyProperty, copyServices, copyServicesFrom, createLiveVersion, createPendingVersion, get, getCategories, getCategoryCollection, getChildren, getContentSection, getContentType, getCreationDate, getCreationIP, getCreationUser, getDisplayName, getDraftVersion, getLanguage, getLastModifiedDate, getLastModifiedIP, getLastModifiedUser, getLifecycle, getLiveVersion, getLocale, getName, getParent, getPath, getPathInfo, getPathInfo, getPathNoJsp, getPendingVersions, getPublicVersion, getVersion, getWorkingVersion, initialize, isDraftVersion, isLive, isLiveVersion, isPendingVersion, isPublished, makeCopy, promotePendingVersion, publish, publishToFS, removeCategory, removeLifecycle, removePendingVersion, set, setContentSection, setContentType, setDefaultCategory, setLanguage, setLifecycle, setLive, setLiveVersion, setName, setParent, setVersion, setVersionRecursively, unpublish, unpublishFromFS
 
Methods inherited from class com.arsdigita.versioning.VersionedACSObject
applyTag, applyUniqueTag, autoPropagateMaster, getMaster, getRolledBackTo, getTransactions, getTransactions, isMaster, isRolledBack, isSubtype, permanentlyDelete, propagateMaster, recordAttributeChange, rollBackTo, rollBackTo, rollForward, save, setMaster, trackChanges
 
Methods inherited from class com.arsdigita.kernel.ACSObject
assertPrivilege, checkPrivilege, doCreateCheck, doWriteCheck, getContainer, getDefaultDomainClass, getID, getSpecificObjectType, getSpecificOID, gimmeContainer, isContainerModified, setID, setID
 
Methods inherited from class com.arsdigita.domain.ObservableDomainObject
addObserver, getObservers
 
Methods inherited from class com.arsdigita.domain.DomainObject
add, add, addToAssociation, afterDelete, clear, delete, disconnect, equals, getObjectType, getOID, getSession, hashCode, isDeleted, isDisconnected, isModified, isNew, isPropertyModified, isValid, remove, remove, remove, removeFromAssociation, save, setAssociation, setAssociation, specializeDataObject, specializeDataObject, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values

BASE_DATA_OBJECT_TYPE

public static final String BASE_DATA_OBJECT_TYPE
See Also:
Constant Field Values
Constructor Detail

ReusableImageAsset

public ReusableImageAsset()
Default constructor. This creates a new image asset.


ReusableImageAsset

public ReusableImageAsset(com.arsdigita.persistence.OID oid)
                   throws com.arsdigita.domain.DataObjectNotFoundException
Constructor. The contained DataObject is retrieved from the persistent storage mechanism with an OID specified by oid.

Parameters:
oid - The OID for the retrieved DataObject.

ReusableImageAsset

public ReusableImageAsset(BigDecimal id)
                   throws com.arsdigita.domain.DataObjectNotFoundException
Constructor. The contained DataObject is retrieved from the persistent storage mechanism with an OID specified by id and ReusableImageAsset.BASE_DATA_OBJECT_TYPE.

Parameters:
id - The id for the retrieved DataObject.

ReusableImageAsset

public ReusableImageAsset(com.arsdigita.persistence.DataObject obj)

ReusableImageAsset

public ReusableImageAsset(String type)
Method Detail

getBaseDataObjectType

public String getBaseDataObjectType()
Overrides:
getBaseDataObjectType in class ImageAsset
Returns:
the base PDL object type for this item. Child classes should override this method to return the correct value

getWidth

public BigDecimal getWidth()
Overrides:
getWidth in class ImageAsset

setWidth

public void setWidth(BigDecimal width)
Overrides:
setWidth in class ImageAsset

getHeight

public BigDecimal getHeight()
Overrides:
getHeight in class ImageAsset

setHeight

public void setHeight(BigDecimal height)
Overrides:
setHeight in class ImageAsset

getContent

protected byte[] getContent()
Retrieves the Blob content.

Overrides:
getContent in class ImageAsset
Returns:
the Blob content

setContent

protected void setContent(byte[] content)
Sets the Blob content.

Overrides:
setContent in class ImageAsset

loadFromFile

public void loadFromFile(String fileName,
                         File file,
                         String defaultMimeType)
                  throws IOException
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.

Overrides:
loadFromFile in class ImageAsset
Parameters:
fileName - The original name of the file
defaultMimeType - The default mime type for the file
file - The actual file on the server
Throws:
IOException

writeToFile

public void writeToFile(File file)
                 throws IOException
Write the image asset content to a file.

Overrides:
writeToFile in class ImageAsset
Parameters:
file - The file on the server to write to.
Throws:
IOException

getAllReusableImages

public static ImageAssetCollection getAllReusableImages()
Retrieve all images in the database. Expensive operation.

Returns:
a collection of ReusableImageAssets

getReusableImagesByKeyword

public static ImageAssetCollection getReusableImagesByKeyword(String keyword,
                                                              String context)
Find all images whose name matches the specified keyword

Parameters:
keyword - a String keyword
context - the context for the retrieved items. Should be ContentItem.DRAFT or ContentItem.LIVE
Returns:
a collection of images whose name matches the keyword

getReusableImagesByKeyword

public static ImageAssetCollection getReusableImagesByKeyword(String keyword)
Find all images whose name matches the specified keyword

Parameters:
keyword - a String keyword
Returns:
a collection of images whose name matches the keyword


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 19 2004:2352 UTC