org.dlese.dpc.schemedit.dcs

Class DcsDataRecord

java.lang.Object

org.dlese.dpc.schemedit.dcs.DcsDataRecord

All Implemented Interfaces:

java.io.Serializable

public class DcsDataRecord
extends java.lang.Object
implements java.io.Serializable

Used to manage dcs_data that is associated with an indexed item-level record. A DcsDataRecord reads from and writes to a file on disk that is named the same as it's "source" item-level record, but in a different directory.

NOTE: the Document attribute should be implemented as a org.dlese.dpc.schemedit.DocMap!!

Author:

ostwald

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DcsDataRecord(java.io.File dcsDataFile, MetaDataFramework framework, CollectionConfig collectionConfig, DcsDataManager dcsDataManager) Constructor for DcsDataRecord.

Method Summary

Modifier and Type	Method and Description
void	clearNdrInfo() Clear the ndrInfo element
void	clearSyncErrors() Clear any errors associated with External repositories, such as the NDR.
boolean	delete() Delete this record by removing it from the cache, destroying the contents, and deleting the source file from disk.
void	deleteStatusEntry(java.lang.String changeDate) Remove specified status entry from the status entry list
protected void	destroy() This method is called at the conclusion of processing and may be used for tear-down.
void	flushToDisk() Write record to disk and then remove it from cashe so any xml processing (such as contracting ampersands) is picked up next time record is needed.
java.lang.String	getChangeDate() Gets the changeDate attribute of the most recent StatusEntry.
java.util.Date	getChangeDateDate() Gets the lastChangeDate (last status update) as a Date.
java.lang.String	getCollection() Gets the collection attribute of the DcsDataRecord object
StatusEntry	getCurrentEntry() Gets the current StatusEntry attribute of the DcsDataRecord object
java.lang.String	getDocType() Gets the docType attribute of the DcsDataRecord, which is 'dcs_data'
org.dom4j.Document	getDocument() Gets Editable (localized and ampersand-expanded) Document for this record.
java.util.List	getEntryList() Returns List of managed suggestions records.
MetaDataFramework	getFramework() Gets the metadata framework of this DcsDataRecord
java.lang.String	getHasSyncError() Returns "true" if there are any sync errors (errors occuring when writing to an external repository, such as the NDR).
java.lang.String	getId() Gets the id attribute of the DcsDataRecord object
java.lang.String	getIsValid() Gets the isValid attribute of the DcsDataRecord object
boolean	getIsValidityUnknown() Returns true
java.lang.String	getLastEditor() Gets the lastEditor attribute of the DcsDataRecord object, reflecting the last time the metadata was changed.
java.lang.String	getLastSyncDate() Gets the lastSyncDate attribute of the DcsDataRecord object
java.util.Date	getLastSyncDateDate() Gets the lastSyncDateDate attribute of the DcsDataRecord object
java.lang.String	getLastTouchDate() Gets the lastTouchDate attribute of the DcsDataRecord object, reflecting the last time the metadata was changed.
java.util.Date	getLastTouchDateDate() Gets the lastTouchDateDate attribute of the DcsDataRecord object
java.lang.String	getMetadataProviderHandle() Gets the ndrHandle attribute of the DcsDataRecord object
java.lang.String	getNdrHandle() Gets the ndrHandle attribute of the DcsDataRecord object
org.dom4j.Element	getNdrInfo() Gets the ndrInfo attribute of the DcsDataRecord object
java.lang.String	getNdrNormalizedStatus()
java.lang.String	getNdrSyncError() Gets the ndrHandle attribute of the DcsDataRecord object
java.lang.String	getNsdlItemId() Gets the nsdlItemId attribute of the DcsDataRecord object
java.lang.String	getPriorStatus() Gets the priorStatus attribute of the DcsDataRecord object
java.lang.String	getSetSpec() Gets the setSpec attribute of the DcsDataRecord object (used to cache the setSpec of collections written to the NDR.
java.io.File	getSource() Gets the source attribute of the DcsDataRecord object
java.lang.String	getStatus() Gets the status attribute of the most recent StatusEntry.
StatusEntry	getStatusEntry(java.lang.String changeDate) Gets the statusEntry corresponding to provided changeDate
java.lang.String	getStatusLabel() Gets the readable representation of this record's status.
java.lang.String	getStatusLabel(java.lang.String value)
java.lang.String	getStatusNote() Gets the statusNote attribute of the most recent StatusEntry.
java.lang.String	getValidationReport() Gets the validationReport attribute of the DcsDataRecord object
org.dom4j.Element	getValidationReportElement() Gets the validationReportElement attribute of the DcsDataRecord object
boolean	hasSyncError() Returns true if this DcsDataRecord has a sync error
boolean	isFinalStatus() Returns true if this record has "Final" status.
boolean	isFinalStatus(java.lang.String value)
boolean	isValid() Gets the valid attribute of the DcsDataRecord object
protected void	normalizeStatus() Ensure that 1) records having a status LABEL equal to the configured final status label also have the correct status VALUE, and 2) records having a final status refer to the correct collection.
void	replaceStatusEntry(java.lang.String changeDate, StatusEntry statusEntry) Removes statusEntry corresponding to provided changeDate, and then adds new statusEntry
void	setCollectionConfig(CollectionConfig collectionConfig)
static void	setDebug(boolean bol) Sets the debug attribute of the DcsDataRecord class
void	setId(java.lang.String id) Sets the id attribute of the DcsDataRecord object
void	setLastEditor(java.lang.String userName) Sets the lastEditor attribute of the DcsDataRecord object
void	setLastSyncDate(java.util.Date date) Sets the lastSyncDate attribute of the DcsDataRecord object
void	setLastSyncDate(java.lang.String dateString) Sets the lastSyncDate attribute of the DcsDataRecord object
void	setLastTouchDate(java.lang.String dateString) Sets the lastTouchDate attribute of the DcsDataRecord object
void	setMetadataProviderHandle(java.lang.String mdpHandle) Sets the ndrHandle attribute of the DcsDataRecord object
void	setNdrHandle(java.lang.String ndrHandle) Sets the ndrHandle attribute of the DcsDataRecord object
void	setNdrSyncError(java.lang.String ndrSyncError) Sets the ndrSyncError attribute of the DcsDataRecord object
void	setNsdlItemId(java.lang.String itemId) Sets the nsdlItemId attribute of the DcsDataRecord object
void	setSetSpec(java.lang.String setSpec) Sets the setSpec attribute of the DcsDataRecord object
void	setSource(java.io.File source) Sets the source attribute of the DcsDataRecord object
void	setValidationReport(java.lang.String report) Sets the validationReport attribute of the DcsDataRecord object
void	updateStatus(StatusEntry statusEntry) Update this record's status with the provided StatusEntry object.
void	updateStatus(StatusEntry statusEntry, boolean retainChangeDate) Update this record's status with the provided StatusEntry object and notify event Listeners of change.
void	updateStatus(java.lang.String status, java.lang.String statusNote, java.lang.String editor) Change the current status of this record.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DcsDataRecord

public DcsDataRecord(java.io.File dcsDataFile,
                     MetaDataFramework framework,
                     CollectionConfig collectionConfig,
                     DcsDataManager dcsDataManager)

Constructor for DcsDataRecord.

Parameters:

dcsDataFile - file on disk containing xml source

framework - this record's framework

collectionConfig - this record's collection

dcsDataManager - manager for all dcsDataRecords

Method Detail

getCollection

public java.lang.String getCollection()

Gets the collection attribute of the DcsDataRecord object

Returns:

The collection value

setCollectionConfig

public void setCollectionConfig(CollectionConfig collectionConfig)

isFinalStatus

public boolean isFinalStatus()

Returns true if this record has "Final" status. A record has final status if the value of the status element in the current status entry has the form: "_|-final-{collection-key}-|_", which is referred to as the final status VALUE. The final status LABEL is a human-readable string that is configured in the collection configuration and stored internally in the collectionConfig.

This method returns true if the status value has the pattern "_|-final-{*}-|_" and as a side effect calls "normalize" to ensure that the collection key part of the status value refers to the correct collection.

Returns:

true if this record has a "final" status.

isFinalStatus

public boolean isFinalStatus(java.lang.String value)

getStatusLabel

public java.lang.String getStatusLabel()

Gets the readable representation of this record's status.

Returns:

status label as String

getStatusLabel

public java.lang.String getStatusLabel(java.lang.String value)

normalizeStatus

protected void normalizeStatus()

Ensure that 1) records having a status LABEL equal to the configured final status label also have the correct status VALUE, and 2) records having a final status refer to the correct collection.

updateStatus

public void updateStatus(java.lang.String status,
                         java.lang.String statusNote,
                         java.lang.String editor)
                  throws java.lang.Exception

Change the current status of this record.

Parameters:

status - new status for this record

statusNote - new status note

editor - user performing status update

Throws:

java.lang.Exception - if status cannot be updated

updateStatus

public void updateStatus(StatusEntry statusEntry)
                  throws java.lang.Exception

Update this record's status with the provided StatusEntry object.

Parameters:

statusEntry - new statusEntry

Throws:

java.lang.Exception - if unable to update

updateStatus

public void updateStatus(StatusEntry statusEntry,
                         boolean retainChangeDate)
                  throws java.lang.Exception

Update this record's status with the provided StatusEntry object and notify event Listeners of change.

Parameters:

statusEntry - new statusEntry

retainChangeDate - if true, change date is not altered

Throws:

java.lang.Exception - if unable to update

getCurrentEntry

public StatusEntry getCurrentEntry()

Gets the current StatusEntry attribute of the DcsDataRecord object

Returns:

The currentEntry value

getEntryList

public java.util.List getEntryList()

Returns List of managed suggestions records. Record entry list is sorted and cashed. When new entryList are added, entryList is set to null so it will be regenerated

Returns:

The entryList value

getStatusEntry

public StatusEntry getStatusEntry(java.lang.String changeDate)

Gets the statusEntry corresponding to provided changeDate

Parameters:

changeDate - key used to locate existing status entry

Returns:

The statusEntry value

replaceStatusEntry

public void replaceStatusEntry(java.lang.String changeDate,
                               StatusEntry statusEntry)
                        throws java.lang.Exception

Removes statusEntry corresponding to provided changeDate, and then adds new statusEntry

Parameters:

changeDate - key used to locate existing status entry

statusEntry - new status entry to be added to record

Throws:

java.lang.Exception - if unable to add status entry (no exception thrown if entry to delete does not exist)

deleteStatusEntry

public void deleteStatusEntry(java.lang.String changeDate)
                       throws java.lang.Exception

Remove specified status entry from the status entry list

Parameters:

changeDate - key used to specify existing status entry

Throws:

java.lang.Exception - NOT YET DOCUMENTED

getFramework

public MetaDataFramework getFramework()

Gets the metadata framework of this DcsDataRecord

Returns:

The framework value

getDocument

public org.dom4j.Document getDocument()
                               throws java.lang.Exception

Gets Editable (localized and ampersand-expanded) Document for this record.

First tries to read from cache, then tries to read from disk, then creates new record.

Returns:

The document value

Throws:

java.lang.Exception - Description of the Exception

getSource

public java.io.File getSource()

Gets the source attribute of the DcsDataRecord object

Returns:

The source value

setSource

public void setSource(java.io.File source)

Sets the source attribute of the DcsDataRecord object

Parameters:

source - The new source value

getIsValid

public java.lang.String getIsValid()

Gets the isValid attribute of the DcsDataRecord object

Returns:

The isValid value

isValid

public boolean isValid()

Gets the valid attribute of the DcsDataRecord object

Returns:

true if the metadata record for this dcsDataRecord is valid

getIsValidityUnknown

public boolean getIsValidityUnknown()

Returns true

Returns:

true if the validitity of the metadata record for this dcsDataRecord is unknown

getValidationReportElement

public org.dom4j.Element getValidationReportElement()

Gets the validationReportElement attribute of the DcsDataRecord object

Returns:

The validationReportElement value

setValidationReport

public void setValidationReport(java.lang.String report)

Sets the validationReport attribute of the DcsDataRecord object

Parameters:

report - The new validationReport value

getValidationReport

public java.lang.String getValidationReport()

Gets the validationReport attribute of the DcsDataRecord object

Returns:

The validationReport value

getLastTouchDate

public java.lang.String getLastTouchDate()

Gets the lastTouchDate attribute of the DcsDataRecord object, reflecting the last time the metadata was changed.

Returns:

The lastTouchDate value

setLastTouchDate

public void setLastTouchDate(java.lang.String dateString)

Sets the lastTouchDate attribute of the DcsDataRecord object

Parameters:

dateString - The new lastTouchDate value

getLastTouchDateDate

public java.util.Date getLastTouchDateDate()

Gets the lastTouchDateDate attribute of the DcsDataRecord object

Returns:

The lastTouchDateDate value

getId

public java.lang.String getId()

Gets the id attribute of the DcsDataRecord object

Returns:

The id value

setId

public void setId(java.lang.String id)

Sets the id attribute of the DcsDataRecord object

Parameters:

id - The new id value

getLastEditor

public java.lang.String getLastEditor()

Gets the lastEditor attribute of the DcsDataRecord object, reflecting the last time the metadata was changed.

Returns:

The lastEditor value

setLastEditor

public void setLastEditor(java.lang.String userName)

Sets the lastEditor attribute of the DcsDataRecord object

Parameters:

dateString - The new lastEditor value

clearNdrInfo

public void clearNdrInfo()

Clear the ndrInfo element

getNdrInfo

public org.dom4j.Element getNdrInfo()

Gets the ndrInfo attribute of the DcsDataRecord object

Returns:

The ndrInfo value

getNdrNormalizedStatus

public java.lang.String getNdrNormalizedStatus()

getNdrHandle

public java.lang.String getNdrHandle()

Gets the ndrHandle attribute of the DcsDataRecord object

Returns:

The ndrHandle value

setNdrHandle

public void setNdrHandle(java.lang.String ndrHandle)

Sets the ndrHandle attribute of the DcsDataRecord object

Parameters:

ndrHandle - The new ndrHandle value

getMetadataProviderHandle

public java.lang.String getMetadataProviderHandle()

Gets the ndrHandle attribute of the DcsDataRecord object

Returns:

The ndrHandle value

setMetadataProviderHandle

public void setMetadataProviderHandle(java.lang.String mdpHandle)

Sets the ndrHandle attribute of the DcsDataRecord object

Parameters:

mdpHandle - The new metadataProviderHandle value

getNsdlItemId

public java.lang.String getNsdlItemId()

Gets the nsdlItemId attribute of the DcsDataRecord object

Returns:

The nsdlItemId value

setNsdlItemId

public void setNsdlItemId(java.lang.String itemId)

Sets the nsdlItemId attribute of the DcsDataRecord object

Parameters:

itemId - The new nsdlItemId value

setLastSyncDate

public void setLastSyncDate(java.lang.String dateString)

Sets the lastSyncDate attribute of the DcsDataRecord object

Parameters:

dateString - The new lastSyncDate value

setLastSyncDate

public void setLastSyncDate(java.util.Date date)

Sets the lastSyncDate attribute of the DcsDataRecord object

Parameters:

date - The new lastSyncDate value

getLastSyncDate

public java.lang.String getLastSyncDate()

Gets the lastSyncDate attribute of the DcsDataRecord object

Returns:

The lastSyncDate value

getLastSyncDateDate

public java.util.Date getLastSyncDateDate()

Gets the lastSyncDateDate attribute of the DcsDataRecord object

Returns:

The lastSyncDateDate value

getNdrSyncError

public java.lang.String getNdrSyncError()

Gets the ndrHandle attribute of the DcsDataRecord object

Returns:

The ndrHandle value

hasSyncError

public boolean hasSyncError()

Returns true if this DcsDataRecord has a sync error

Returns:

NOT YET DOCUMENTED

getHasSyncError

public java.lang.String getHasSyncError()

Returns "true" if there are any sync errors (errors occuring when writing to an external repository, such as the NDR).

Returns:

The hasSyncError value

setNdrSyncError

public void setNdrSyncError(java.lang.String ndrSyncError)

Sets the ndrSyncError attribute of the DcsDataRecord object

Parameters:

ndrSyncError - The new ndrSyncError value

clearSyncErrors

public void clearSyncErrors()

Clear any errors associated with External repositories, such as the NDR. This method should be called before each write.

getSetSpec

public java.lang.String getSetSpec()

Gets the setSpec attribute of the DcsDataRecord object (used to cache the setSpec of collections written to the NDR.

Returns:

The setSpec value

setSetSpec

public void setSetSpec(java.lang.String setSpec)

Sets the setSpec attribute of the DcsDataRecord object

Parameters:

setSpec - The new setSpec value

getStatus

public java.lang.String getStatus()

Gets the status attribute of the most recent StatusEntry.

Returns:

The status value

getPriorStatus

public java.lang.String getPriorStatus()

Gets the priorStatus attribute of the DcsDataRecord object

Returns:

The priorStatus value

getStatusNote

public java.lang.String getStatusNote()

Gets the statusNote attribute of the most recent StatusEntry.

Returns:

The statusNote value

getChangeDate

public java.lang.String getChangeDate()

Gets the changeDate attribute of the most recent StatusEntry. This reflects the last time a status was changed.

Returns:

The changeDate value

getChangeDateDate

public java.util.Date getChangeDateDate()

Gets the lastChangeDate (last status update) as a Date.

Returns:

The lastTouchDateDate value

flushToDisk

public void flushToDisk()
                 throws java.lang.Exception

Write record to disk and then remove it from cashe so any xml processing (such as contracting ampersands) is picked up next time record is needed.

Throws:

java.lang.Exception - If record cannot be written to disk.

delete

public boolean delete()
               throws java.lang.Exception

Delete this record by removing it from the cache, destroying the contents, and deleting the source file from disk.

Returns:

Description of the Return Value

Throws:

java.lang.Exception - NOT YET DOCUMENTED

getDocType

public java.lang.String getDocType()

Gets the docType attribute of the DcsDataRecord, which is 'dcs_data'

Returns:

The docType, which is 'dlese_collect.'

destroy

protected void destroy()

This method is called at the conclusion of processing and may be used for tear-down.

setDebug

public static void setDebug(boolean bol)

Sets the debug attribute of the DcsDataRecord class

Parameters:

bol - The new debug value