Package com.jalios.jcms.tracking

Class ReaderTracker

java.lang.Object

com.jalios.jstore.BasicStorable

com.jalios.jcms.Data

com.jalios.jcms.tracking.ReaderTracker

All Implemented Interfaces:

DBData, JcmsConstants, ImportConstants, MashupConstants, Storable, JaliosConstants, LangPropertyArgument, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<BasicStorable>

public class ReaderTracker
extends Data
implements DBData

See Also:

Serialized Form

Nested Class Summary

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

Data.AuthorComparator<T extends Data>, Data.AuthorizedSelector, 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

Fields

Modifier and Type	Field	Description
static int	ACCESS_TYPE_DOWNLOAD
static int	ACCESS_TYPE_READER
static int	HIBERNATE_MAPPING_PUBLICATIONID
static java.lang.String	REVISION

Fields inherited from class com.jalios.jcms.Data

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

Fields inherited from class com.jalios.jstore.BasicStorable

cdate, ddate, id, isStoreCache, 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.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

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

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

Constructor Summary

Constructors

Constructor	Description
ReaderTracker()
ReaderTracker(ReaderTracker other)

Method Summary

Modifier and Type	Method	Description
int	getAccessCount()
int	getAccessType()
java.util.Date	getAckDate()
java.lang.String	getAckVersion()
static java.lang.String	getCSVHeader(java.lang.String userLang)
java.util.Date	getFirstAccessDate()	Returns the first access date.
java.util.Date	getLastAccessDate()	Returns the last access date.
Publication	getPublication()	Get the value of publication.
java.lang.String	getPublicationId()
boolean	hasBeenAck()	Returns true if this ReaderTracker contains a reading confirmation (read ack) which date is valid.
void	incrementAccessCount()	Increments the access count (+1)
void	incrementAccessCount(int count)	Increments the access count with the given count.
void	setAccessCount(int accessCount)
void	setAccessType(int accessType)
void	setAccessType(java.lang.Integer accessType)
void	setAckDate(java.util.Date ackDate)
void	setAckVersion(java.lang.String ackVersion)
void	setAuthorId(java.lang.String authordId)	Sets the JStore ID of the author (only for DBData).
void	setPublication(Publication v)	Set the value of publication.
void	setPublicationId(java.lang.String v)
java.lang.String	toCSV(java.lang.String userLang)	Returns a CSV view of this object
java.lang.String	toString()

Methods inherited from class com.jalios.jcms.Data

canBeReadBy, canBeReadBy, canBeUnlockedBy, canRequestUnlock, checkAndPerformCreate, checkAndPerformCreate, checkAndPerformDelete, checkAndPerformDelete, checkAndPerformUpdate, checkAndPerformUpdate, checkCreate, checkCreate, checkDelete, checkDelete, checkIntegrity, checkIntegrity, checkLockMember, checkMember, checkStrongLockMember, checkStrongLockMember, checkUpdate, checkUpdate, checkWrite, cleanHybridCollection, cleanHybridCollection, cleanHybridCollection, cleanHybridCollections, clone, computeDBIDArray, computeDBIDList, computeDBIDSet, exportXml, exportXml, exportXml, exportXml, exportXmlField, exportXmlRelated, exportXmlRelated, fillExportXmlFieldAttributes, getAllReferrerSet, getAllReferrerSet, getAllTypeFieldEntry, getAuthor, getAuthor, getAuthorComparator, getAuthorDBID, getAuthorId, getAuthorSelector, getBooleanFieldValue, getBooleanFieldValue, getCaddyComparator, getCategoryFieldValue, getCategoryFieldValue, getCdateSelector, getComparator, getDataIcon, getDataIconAlt, getDataIconCSS, getDataIconHtml, getDataIconHtml, getDataIconTitle, getDataImage, getDataImage, getDataImage, getDataName, getDataNameComparator, getDate, getDate, getDateSelector, getDeletableSelector, getDisplayLink, getDisplayLink, getDisplayLink, getDisplayLinkCss, getDisplayLinkDataAttribute, getDisplayLinkHtmlAttributes, getDisplayUrl, getDoubleFieldValue, getDoubleFieldValue, getExportXmlDataValue, getExtension, getExtraData, getExtraDataMap, getExtraDBData, getExtraDBDataMap, getExtraInfo, getExtraInfoMap, getFieldStatusMap, getFieldValue, getFieldValue, getFieldValue, getFieldValue, getGenericThumbnail, getGenericThumbnail, 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, getOpAuthorId, getOpDelegate, getReadAuthorizedSelector, getReferrerSet, getRowId, getRowIdComparator, getStrongLock, getStrongLockContext, getStrongLockContextData, getStrongLockDate, getStrongLockInfo, getStrongLockMember, getStrongLockSelector, getTypeEntry, getTypeFieldsEntries, getUpdateInstance, getVirtualIDSet, importXml, importXmlFieldsWithReferences, importXmlFiles, importXmlReferences, initializeDBDataCollections, isDBData, isImported, isImportUpdated, isInDatabase, isLocked, isPersisted, isStrongLocked, lock, markNewImport, mergeHybridLink, mergeHybridLink, performAfterWrite, performBeforeWrite, performCreate, performCreate, performDelete, performDelete, performUpdate, performUpdate, prepareUpdateContext, printDataName, printDisplayLinkEnd, printDisplayLinkStart, printDisplayLinkStart, printDisplayUrl, printDisplayUrl, putStrongLock, putStrongLock, releaseStrongLock, releaseStrongLock, removeExtraData, removeExtraDBData, removeExtraInfo, setAuthor, setAuthorDBID, setBooleanFieldValue, setCategoryFieldValue, setDoubleFieldValue, setExtension, setExtraData, setExtraDataMap, setExtraDBData, setExtraDBDataMap, setExtraDBDataMap, setExtraInfo, setFieldValue, setFieldValue, setId, setImportAuthor, setImportBatch, setImportDate, setImportDisplayUrl, setImportId, setImportMap, setImportMdate, setImportSignature, setImportSource, setImportSourceUrl, setImportUpdated, setIntFieldValue, setLongFieldValue, setMdate, setOpAuthor, setOpAuthorId, setOpDelegate, setRowId, splitHybridCollections, toFullString, unlock, unlock, unmarkNewImport, updateDisplayLinkCss, updateDisplayLinkDataAttribute, updateDisplayLinkHtmlAttributes, 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, hashCode, isStored, resetInternalCaches, resolveAtt, resolveVal, setAttributes, setAttributes, setCdate, setDdate, setStore, toXml

Methods inherited from class java.lang.Object

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

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

getRowId, setRowId

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

ACCESS_TYPE_READER

public static final int ACCESS_TYPE_READER

See Also:

Constant Field Values

ACCESS_TYPE_DOWNLOAD

public static final int ACCESS_TYPE_DOWNLOAD

See Also:

Constant Field Values

HIBERNATE_MAPPING_PUBLICATIONID

public static final int HIBERNATE_MAPPING_PUBLICATIONID

See Also:

Constant Field Values

Constructor Detail

ReaderTracker

public ReaderTracker()

ReaderTracker

public ReaderTracker(ReaderTracker other)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class Data

incrementAccessCount

public void incrementAccessCount()

Increments the access count (+1)

Since:

jcms-6.0.0

incrementAccessCount

public void incrementAccessCount(int count)

Increments the access count with the given count.

Parameters:

count - the count to add to the current access count

Since:

jcms-6.0.0

getFirstAccessDate

public java.util.Date getFirstAccessDate()

Returns the first access date.

Returns:

the first access date.

Since:

jcms-7.0.0

getLastAccessDate

public java.util.Date getLastAccessDate()

Returns the last access date.

Returns:

the last access date.

Since:

jcms-7.0.0

setAuthorId

public void setAuthorId(java.lang.String authordId)

Description copied from class: Data

Sets the JStore ID of the author (only for DBData).

If the specified authorId is an invalid ID (non existing Member), the author will be set to the Member specified by property channel.default-author (or left null if this property has not been set).

Overrides:

setAuthorId in class Data

Parameters:

authordId - the JStore author id

getPublication

public Publication getPublication()

Get the value of publication.

Returns:

Value of publication.

Since:

jcms-6.0

setPublication

public void setPublication(Publication v)

Set the value of publication.

Parameters:

v - Value to assign to publication.

Since:

jcms-6.0

getPublicationId

public java.lang.String getPublicationId()

setPublicationId

public void setPublicationId(java.lang.String v)

getAccessCount

public int getAccessCount()

setAccessCount

public void setAccessCount(int accessCount)

getAccessType

public int getAccessType()

Returns:

value of accessType

Since:

jcms-8.0.0

setAccessType

public void setAccessType(int accessType)

Parameters:

accessType - value to assign to accessType

Since:

jcms-8.0.0

setAccessType

public void setAccessType(java.lang.Integer accessType)

Parameters:

accessType - value to assign to accessType

Since:

jcms-8.0.0

getAckDate

public java.util.Date getAckDate()

Returns:

the acknowledge date

Since:

jcms-10.0.5

setAckDate

public void setAckDate(java.util.Date ackDate)

Parameters:

ackDate - the acknowledge date

Since:

jcms-10.0.5

getAckVersion

public java.lang.String getAckVersion()

Returns:

the version the member acknowledge the reading

Since:

jcms-10.0.5

setAckVersion

public void setAckVersion(java.lang.String ackVersion)

Parameters:

ackVersion - the version the member acknowledge the reading

Since:

jcms-10.0.5

hasBeenAck

public boolean hasBeenAck()

Returns true if this ReaderTracker contains a reading confirmation (read ack) which date is valid.

Ack date is valid when it occured after publication's last major modification date.

(major modification date is publication's major modification date udate if any, else its creation date cdate).

Returns:

true if this ReaderTracker contains a valid reading confirmation.

Since:

jcms-10.0.5

getCSVHeader

public static java.lang.String getCSVHeader(java.lang.String userLang)

Parameters:

userLang - the language of the user

Returns:

csv headers for ReaderTracker csv export

toCSV

public java.lang.String toCSV(java.lang.String userLang)

Description copied from class: Data

Returns a CSV view of this object

Overrides:

toCSV in class Data

Parameters:

userLang - the output language

Returns:

a CSV view of this object

See Also:

Returns a CSV view of this object