com.jalios.jcms
Class DBFileDocument

java.lang.Object
  com.jalios.jstore.BasicStorable
      com.jalios.jcms.Data
          com.jalios.jcms.Publication
              com.jalios.jcms.Content
                  com.jalios.jcms.FileDocument
                      com.jalios.jcms.DBFileDocument

All Implemented Interfaces:

CategorizedDBData, DBData, HistorizedDBData, OpenRoleDBData, EditableData, JcmsConstants, ImportConstants, MashupConstants, StrongLockable, Searchable, Storable, JaliosConstants, LangPropertyArgument, TreeNode, Serializable, Cloneable, Comparable<BasicStorable>

public class DBFileDocument
extends FileDocument
implements CategorizedDBData, HistorizedDBData, OpenRoleDBData

Version:

$Revision: 48296 $

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.jalios.jcms.FileDocument

FileDocument.AssociatedFileFilter, FileDocument.ContentTypeComparator<T extends FileDocument>, FileDocument.ContentTypeSelector, FileDocument.DeleteThumbnailListener, FileDocument.DimensionsComparator<T extends FileDocument>, FileDocument.DurationComparator<T extends FileDocument>, FileDocument.HiddenSelector, FileDocument.MediaTypeSelector, FileDocument.SizeComparator<T extends FileDocument>, FileDocument.SizeSelector

Nested classes/interfaces inherited from class com.jalios.jcms.Publication

Publication.AdateComparator<T extends Publication>, Publication.AdateSelector, Publication.AudienceRightComparator<T extends Publication>, Publication.AudienceRightSelector, Publication.AuthorComparator<T extends Publication>, Publication.AuthorizedSelector, Publication.CanWorkOnSelector, Publication.DdateComparator<T extends Publication>, Publication.EdateComparator<T extends Publication>, Publication.EdateSelector, Publication.PdateComparator<T extends Publication>, Publication.PdateSelector, Publication.PstatusComparator<T extends Publication>, Publication.PstatusSelector, Publication.RatingComparator<T extends Publication>, Publication.ReaderComparator<T extends Publication>, Publication.ReadRightSelector, Publication.ReviewCountComparator<T extends Publication>, Publication.RightComparator<T extends Publication>, Publication.SdateComparator<T extends Publication>, Publication.SdateSelector, Publication.TitleComparator<T extends Publication>, Publication.TrackedSelector, Publication.TypeComparator<T extends Publication>, Publication.UdateComparator<T extends Publication>, Publication.UdateSelector, Publication.UserContentSelector, Publication.VisibleStateSelector, Publication.WorkspaceAuthorSelector, Publication.WorkspaceComparator<T extends Publication>, Publication.WorkspaceSelector

Nested classes/interfaces inherited from class com.jalios.jcms.Data

Data.AuthorSelector, Data.CdateSelector, Data.DataNameComparator<T extends Data>, Data.DeletableSelector, Data.ImportSelector, Data.MdateSelector, Data.OpAuthorComparator<T extends Data>, Data.RowIdComparator<T extends Data>, Data.StrongLockSelector

Nested classes/interfaces inherited from class com.jalios.jstore.BasicStorable

BasicStorable.CdateComparator<T extends Storable>, BasicStorable.IdComparator<T extends Storable>, BasicStorable.MdateComparator<T extends Storable>

Field Summary

static String	CONTENT_TYPE_FIELD
static String	DESCRIPTION_FIELD
static String	FILENAME_FIELD
static String	ORIGINAL_FILENAME_FIELD
static String	REVISION
static String	UPLOAD_DATE_FIELD

Fields inherited from class com.jalios.jcms.FileDocument

contentType, DEFAULT_DETAIL_VIEW_PROP, DEFAULT_WORKFLOW, description, descriptionML, filename, HIDDEN_PSTATUS, isDefaultDetailView, OPENOFFICE_MIMETYPE, OPENXML_PRESENTATION_MIMETYPE, originalFilename, THUMBNAIL_PREFIX, THUMBNAIL_REGEXP, uploadDate

Fields inherited from class com.jalios.jcms.Publication

adate, allCatIdSet, authGrpIdSet, authGrpIdSetDirty, authGrpIdSetInit, authMbrIdSet, authMbrIdSetDirty, authMbrIdSetInit, authorizedGroupSet, authorizedMemberSet, categories, categorySet, catIdSet, catIdSetDirty, catIdSetInit, CTRL_TOPIC_ADVANCED, CTRL_TOPIC_CATEGORIES, CTRL_TOPIC_WORKFLOW, edate, friendlyURLSet, hasNoReadRightsDBData, indexMgr, isTracked, mainInstance, mainLanguage, majorVersion, mergeDate, mergeId, minorVersion, pdate, pstatus, readerCount, roleMap, sdate, templates, title, titleML, udate, updateGroupSet, updateMemberSet, wfExpressAlarmEntry, wfReminderAlarmEntry, workflowId, workspace

Fields inherited from class com.jalios.jcms.Data

author, authorDBID, channel, DISPLAY_URL_EXTRA_INFO, extension, extraDataMap, extraDBDataMapToSaveOnOp, importMap, opAuthor, opDelegate

Fields inherited from class com.jalios.jstore.BasicStorable

cdate, ddate, id, mdate, store

Fields inherited from interface com.jalios.jcms.mashup.ImportConstants

IMPORT_ALARM_MGR, IMPORT_AUTHOR_PROP, IMPORT_CATEGORY_DEFAULT, IMPORT_DC_ATTR, IMPORT_DC_STEP, IMPORT_DIR, IMPORT_ENABLED, IMPORT_JDOM_ELEMENT, IMPORT_LOG_FILE, IMPORT_LOG_MAX, IMPORT_OPTIONS, IMPORT_OPTIONS_DC_CONTEXT, IMPORT_ROOT_PROP, IMPORT_SOURCE_FILE, IMPORT_SOURCE_PREFIX_PROP, IMPORT_SOURCES_DIR, IMPORT_STEP_CLEAN, IMPORT_STEP_IMPORT, IMPORT_STEP_UPDATE_REF, IMPORT_WS_PROP

Fields inherited from interface com.jalios.jcms.mashup.MashupConstants

DATA_TAG, DATASET_TAG, FIELD_CLASS, FIELD_ENTRY, FIELD_ITEM, FIELD_KEY, FIELD_NAME, FIELD_TAG, FIELD_VALUE, FILE_FIELD, FILE_ID, FILE_MTIME, FILE_SIZE, FILE_TAG, FILE_TICKET, FILESET_TAG, RELATED_TAG

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_DEEP_COPY, OP_DEEP_DELETE, OP_DELETE, OP_MERGE, OP_UPDATE, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Constructor Summary

DBFileDocument()

DBFileDocument(DBFileDocument other)

DBFileDocument(FileDocument other)

Method Summary

ControllerStatus	checkCreate(Member mbr, Map context) Checks if the creation can be performed
DBDataRevision	getDBDataRevision(Data data, int op)
static FileDocument	getInstance(String filename) Constructs a FileDocument from an existing file.
static FileDocument	getInstance(String filename, Member author, Workspace ws) Constructs a FileDocument from an existing file.
static FileDocument	getInstance(String filename, String title, String description, Category[] categories) Constructs a FileDocument from an existing file.
static FileDocument	getInstance(String filename, String title, String description, Category[] categories, Member author, Workspace ws) Constructs a FileDocument from an existing file.
protected void	performAfterWrite(int op, Member mbr, Map context) Called to perform some action after the write.

Methods inherited from class com.jalios.jcms.FileDocument

canBeReadBy, canCreateCopy, checkIntegrity, clearInternalCache, computeSignature, deleteAssociatedFiles, deleteAssociatedPDF, deleteThumbnails, deleteThumbnails, directoryToFileDocuments, exportXmlField, getAbstract, getAbstract, getAccessibilityInformation, getAllFilePath, getAllWikiText, getAssociatedFileSet, getAssociatedPDF, getComparator, getContentType, getContentTypeComparator, getDataImage, getDataImage, getDefaultContentType, getDefaultWorkflow, getDescription, getDescription, getDescription, getDescriptionML, getDimensions, getDimensionsComparator, getDuration, getDurationComparator, getExportXmlDataValue, getExtension, getFieldValue, getFile, getFileDocumentFromFile, getFileDocumentFromFilename, getFileFromThumbnail, getFileIndexingDate, getFilename, getFileReferrerSet, getGenericContentType, getGenericThumbnail, getHeight, getHiddenSelector, getIcon, getIndexedDate, getInstance, getLastModified, getLockedDocumentSet, getLuceneDocument, getMediaType, getMediaTypeSelector, getMetaData, getMetaDataMap, getNewDocumentDirectoryAndName, getNewDocumentFilename, getOriginalDocumentFromPDF, getOriginalFilename, getQualifiedName, getRealContentType, getSearchStrings, getSize, getSizeComparator, getThumbnailFile, getThumbnailFilename, getTypeInfo, getUploadDate, getWeakReferrerSet, getWidth, hasStrongLock, importXml, importXmlFieldsWithReferences, internalCanBeReadBy, isAudio, isDefaultDetailView, isFlash, isGeneratedPDF, isGenericContentType, isImage, isIndexed, isMedia, isText, isThumbnail, isVideo, isWebImage, performDelete, performUpdate, setContentType, setDescription, setDescription, setDescriptionML, setFieldValue, setFilename, setOriginalFilename, setUploadDate, supportsThumbnail, unzipToFileDocuments, unzipToFileDocuments

Methods inherited from class com.jalios.jcms.Publication

addAuthorizedGroup, addAuthorizedMember, addCategory, addFollower, addWeakReferrer, addWFExpressAlarm, addWFReminderAlarm, assignCommonPublicationFields, assignRole, assignRole, canBeArchived, canBeArchived, canBeEditedFieldByField, canBeFollowedBy, canBeReadBy, canBeReadBy, canBeReadBy, canBeReadBy, canCreateCopy, canCreateWorkCopy, canMergeWorkCopy, checkDelete, checkLang, checkMember, checkMerge, checkStateChange, checkStateChange, checkTemplateEntry, checkUpdate, checkWrite, clearTransientIndex, cloneDBDataCollections, computeSignature, containsCategory, createCopy, createWFNote, createWFNote, createWorkCopy, getAbstract, getAbstractML, getAccessCount, getAdate, getAdateComparator, getAdateSelector, getAllCatIdSet, getAllWysiwygText, getAudiencedRightsString, getAudienceRightComparator, getAudienceRightSelector, getAuthGrpIdSet, getAuthMbrIdSet, getAuthorizedGroupSet, getAuthorizedMemberSet, getAuthorizedSelector, getCanWorkOnSelector, getCategories, getCategories, getCategorySet, getCatIdSet, getComparator, getComparator, getCSVHeader, getDataName, getDate, getDate, getDateSelector, getDdateComparator, getDefaultTemplateUsage, getDescendantCategorySet, getDescendantCategorySet, getDescendantCategorySet, getDisplayTemplateFile, getDocumentLinkSet, getEdate, getEdateComparator, getEdateSelector, getEstimatedReminderCount, getExternalLinkSet, getFieldInMainLanguage, getFirstDescendantCategory, getFirstDescendantCategory, getFirstDescendantCategory, getFollowerList, getFriendlyURLSet, getGlobalRating, getHasNoReadRights, getImportConflictCopy, getImportVersion, getIndexingDate, getInternalWorkflow, getLinkDataSet, getMainInstance, getMainLanguage, getMajorVersion, getMemberSetAssignedToRole, getMergeDate, getMergeId, getMinorVersion, getNextWFStateSet, getPdate, getPdateComparator, getPdateSelector, getPstatus, getPstatusAlarmEntry, getPstatusComparator, getPstatusSelector, getPstatusSelector, getQueryTemplateFile, getRatingComparator, getReaderComparator, getReaderCount, getReaderTrackerList, getReadRightSelector, getReadRightsString, getReview, getReviewCount, getReviewCountComparator, getReviewList, getReviewList, getRightComparator, getRoleMap, getRoleMapStr, getSdate, getSdateComparator, getSdateSelector, getTemplate, getTemplateEntry, getTemplateEntry, getTemplateEntrySet, getTemplatePath, getTemplatePath, getTemplates, getTitle, getTitle, getTitle, getTitleComparator, getTitleComparator, getTitleML, getTrackedSelector, getTreeChildren, getTreeParent, getTreeRoot, getTypeComparator, getTypeLabel, getUdate, getUdateComparator, getUdateSelector, getUpdateGroupSet, getUpdateMemberSet, getVersionString, getVisibleStateSelector, getWFNoteList, getWFState, getWFStateLabel, getWFStateLabelHtml, getWorkCopySet, getWorkflow, getWorkflowId, getWorkspace, getWorkspaceAuthorSelector, getWorkspaceComparator, getWorkspaceId, getWorkspaceSelector, getWSTypeEntry, getWSTypeEntry, hasAlreadyVoted, hasAnyReadRights, hasBeenReadBy, hasCategory, hasImportConflict, hasNoReadRights, hasReview, hasWeakReferrers, importConvertToLocal, importMarkAsMerged, importOverrideAndUpdate, init, initCopy, initializeDBDataCollections, isAudienced, isDefaultTemplate, isFollowedBy, isImportConflictCopy, isInRole, isInVisibleState, isPublic, isRoleAssigned, isTracked, isTreeLeaf, isTreeNode, isUserContent, isUserContentType, isVersioned, isWorkCopy, majorUpdate, notifyFollowers, performBeforeWrite, performCreate, performMerge, performMerge, prepareMergeCopy, putPstatusAlarmEntry, removeAllDescendants, removeAllFollowers, removeAllReaderTracker, removeAuthorizedGroup, removeAuthorizedMember, removeCategory, removeDataSet, removeFollower, removeImportMetadata, removePstatusAlarmEntry, removeWeakReferrer, removeWFExpressAlarm, removeWFReminderAlarm, resolveTypeTemplateEntry, setAbstract, setAbstract, setAdate, setAllCatIdSet, setAuthGrpIdSet, setAuthMbrIdSet, setAuthorizedGroupSet, setAuthorizedMemberSet, setCategories, setCategorySet, setCatIdSet, setCdate, setEdate, setFriendlyURLSet, setHasNoReadRights, setImportConflictCopy, setImportVersion, setMainInstance, setMainLanguage, setMajorVersion, setMergeDate, setMergeId, setMinorVersion, setPdate, setPstatus, setReaderCount, setRoleMap, setRoleMapStr, setRoleMemberSetMap, setSdate, setTemplate, setTemplates, setTitle, setTitle, setTitleML, setTracked, setUdate, setUpdateGroupSet, setUpdateMemberSet, setWorkflow, setWorkflowId, setWorkspace, setWorkspaceId, toCSV, toFullString, toString, trackReader, unassignMember, unassignRole, updatePstatus, updateTemplate

Methods inherited from class com.jalios.jcms.Data

canRequestLock, checkCreate, checkDelete, checkIntegrity, checkLockMember, checkStrongLockMember, checkUpdate, clone, computeDBIDArray, exportXml, exportXml, exportXml, exportXml, exportXmlRelated, exportXmlRelated, fillExportXmlFieldAttributes, getAllReferrerSet, getAllReferrerSet, getAllTypeFieldEntry, getAuthor, getAuthor, getAuthorComparator, getAuthorDBID, getAuthorId, getAuthorSelector, getBooleanFieldValue, getBooleanFieldValue, getCaddyComparator, getCategoryFieldValue, getCategoryFieldValue, getCdateSelector, getDataImage, getDataNameComparator, getDeletableSelector, getDisplayLink, getDisplayLink, getDisplayUrl, getDoubleFieldValue, getDoubleFieldValue, getExtension, getExtraData, getExtraDataMap, getExtraDBData, getExtraDBDataMap, getExtraInfo, getExtraInfoMap, getFieldStatusMap, getFieldValue, getFieldValue, getFieldValue, getImportAuthor, getImportBatch, getImportDate, getImportDisplayUrl, getImportId, getImportMap, getImportMdate, getImportSelector, getImportSignature, getImportSource, getImportSourceUrl, getImportUrl, getIntFieldValue, getIntFieldValue, getLangPropertyValue, getLinkCount, getLinkIndexedDataSet, getLinkIndexedDataSet, getLockDate, getLockInfo, getLockMember, getLongFieldValue, getLongFieldValue, getMdateSelector, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getNewDefaultExtraDBDataMap, getOpAuthor, getOpAuthorComparator, getOpDelegate, getRowId, getRowIdComparator, getStrongLock, getStrongLockDate, getStrongLockInfo, getStrongLockMember, getStrongLockSelector, getTypeEntry, getTypeFieldsEntries, getUpdateInstance, hashCode, importXmlFiles, importXmlReferences, isDBData, isImported, isImportUpdated, isInDatabase, isLocked, isPersisted, isStrongLocked, lock, markNewImport, mergeHybridLink, performCreate, performDelete, performUpdate, prepareUpdateContext, printDataName, printDisplayLinkEnd, printDisplayLinkStart, printDisplayUrl, printDisplayUrl, putStrongLock, releaseStrongLock, releaseStrongLock, removeExtraData, removeExtraDBData, removeExtraInfo, setAuthor, setAuthorDBID, setAuthorId, setBooleanFieldValue, setCategoryFieldValue, setDoubleFieldValue, setExtension, setExtraData, setExtraDataMap, setExtraDBData, setExtraDBDataMap, setExtraDBDataMap, setExtraInfo, setFieldValue, setImportAuthor, setImportBatch, setImportDate, setImportDisplayUrl, setImportId, setImportMap, setImportMdate, setImportSignature, setImportSource, setImportSourceUrl, setImportUpdated, setIntFieldValue, setLongFieldValue, setMdate, setOpAuthor, setOpDelegate, setRowId, unlock, unlock, unmarkNewImport, updateExtraDataMap, updateExtraDBDataMap, updateIndexTreeSet

Methods inherited from class com.jalios.jstore.BasicStorable

clearId, compareTo, equals, getAttribute, getAttributes, getCdate, getCdateComparator, getDdate, getId, getIdComparator, getMdate, getMdateComparator, getStore, getUrid, hasBeenUpdated, isStored, resolveAtt, resolveVal, setAttributes, setDdate, setId, setStore, toXml

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jalios.jcms.db.CategorizedDBData

getAllCatIdSet, getCatIdSet, setAllCatIdSet, setCatIdSet

Methods inherited from interface com.jalios.jcms.db.DBData

getRowId, setRowId

Field Detail

REVISION

public static final String REVISION

See Also:

Constant Field Values

DESCRIPTION_FIELD

public static final String DESCRIPTION_FIELD

See Also:

Constant Field Values

FILENAME_FIELD

public static final String FILENAME_FIELD

See Also:

Constant Field Values

ORIGINAL_FILENAME_FIELD

public static final String ORIGINAL_FILENAME_FIELD

See Also:

Constant Field Values

CONTENT_TYPE_FIELD

public static final String CONTENT_TYPE_FIELD

See Also:

Constant Field Values

UPLOAD_DATE_FIELD

public static final String UPLOAD_DATE_FIELD

See Also:

Constant Field Values

Constructor Detail

DBFileDocument

public DBFileDocument()

DBFileDocument

public DBFileDocument(DBFileDocument other)

DBFileDocument

public DBFileDocument(FileDocument other)

Method Detail

getDBDataRevision

public DBDataRevision getDBDataRevision(Data data,
                                        int op)

Overrides:

getDBDataRevision in class Publication

checkCreate

public ControllerStatus checkCreate(Member mbr,
                                    Map context)

Description copied from class: Publication

Checks if the creation can be performed

Overrides:

checkCreate in class Publication

Parameters:

mbr - the member which requests the write operation

context - a map which contains context parameters (may be null)

Returns:

a ControllerStatus

performAfterWrite

protected void performAfterWrite(int op,
                                 Member mbr,
                                 Map context)

Description copied from class: Data

Called to perform some action after the write.

Overrides:

performAfterWrite in class FileDocument

Parameters:

op - the operation (OP_CREATE, OP_UPDATE, ...)

mbr - the member which requests the write operation

context - a map which contains context parameters (may be null)

getInstance

public static FileDocument getInstance(String filename)

Constructs a FileDocument from an existing file. The FileDocument is not created in the store.

Parameters:

filename - the filename. It must be relative to the context path

Returns:

a FileDocument wrapped to the given file or null if this file does not exist

Since:

jcms-6.2.0

getInstance

public static FileDocument getInstance(String filename,
                                       Member author,
                                       Workspace ws)

Constructs a FileDocument from an existing file. The FileDocument is not created in the store.

Parameters:

filename - the filename. It must be relative to the context path

author - the author of the document or null

ws - the workspace of the publication

Returns:

a FileDocument wrapped to the given file or null if this file does not exist

Since:

jcms-6.2.0

getInstance

public static FileDocument getInstance(String filename,
                                       String title,
                                       String description,
                                       Category[] categories)

Constructs a FileDocument from an existing file. The FileDocument is not created in the store.

Parameters:

filename - the filename. It must be relative to the context path

title - a proposed title (if null, use the name without its extension as title)

description - the description (may be null)

categories - the categories (may be null)

Returns:

a FileDocument wrapped to the given file or null if this file does not exist

Since:

jcms-6.2.0

getInstance

public static FileDocument getInstance(String filename,
                                       String title,
                                       String description,
                                       Category[] categories,
                                       Member author,
                                       Workspace ws)

Constructs a FileDocument from an existing file. The FileDocument is not created in the store.

Parameters:

filename - the filename. It must be relative to the context path

title - a proposed title (if null, use the name without its extension as title)

description - the description (may be null)

categories - the categories (may be null)

author - the author of the document or null

ws - the workspace of the publication

Returns:

a FileDocument wrapped to the given file or null if this file does not exist

Since:

jcms-6.2.0