com.exlibris.digitool.repository.api

Interface IEEditor

public interface IEEditor

An interface for retrieval and editing of control's DnxDocuments and DublinCore. Taking into consideration performances issues, background Maps manage all DnxDocumentsHelper and DublinCore objects that have been modified.

Author:

yaarac

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,DublinCore>	getChangedDcs() Returns a Map consisting of changed pids and their changed DublinCore objects.
java.util.Map<java.lang.String,DnxDocumentHelper>	getChangedDnxs() Returns a Map consisting of changed pids and their changed DnxDocumentHelper objects.
DublinCore	getDc(java.lang.String pid) Returns a DublinCore object for a given control by its pid.
DublinCore	getDcForIE() Returns a DublinCore object for the given IE.
DnxDocumentHelper	getDnxHelper(java.lang.String pid) Returns a DnxDocumentHelper object for a given control by its pid.
DnxDocumentHelper	getDnxHelperForIE() Returns a DnxDocumentHelper object for the given IE.
java.util.List<java.lang.String>	getFilesForRep(java.lang.String repPid) Returns a list of File identifiers by the given representation pid.
java.lang.String	getIEPid() Returns the identifier of the IE this IEEditor is working on.
java.util.List<java.lang.String>	getReps() Returns a list of representation identifiers for the given IE.
void	setDC(DublinCore dc, java.lang.String pid) Sets the given DublinCore object for the given control, by its pid.
void	setDCForIE(DublinCore dc) Sets the given DublinCore object for the given IE.
void	setDnx(DnxDocumentHelper dnxHelper, java.lang.String pid) Sets the given DnxDocumentHelper object with its DnxDocument for the given control, by its pid.
void	setDnxForIE(DnxDocumentHelper dnxHelper) Sets the given DnxDocumentHelper object with its DnxDocument for the given IE.

Method Detail

getDc

DublinCore getDc(java.lang.String pid)
          throws java.lang.Exception

Returns a DublinCore object for a given control by its pid.

Parameters:

pid - the control's identifier

Returns:

A DublinCore object representing the control's descriptive metadata

Throws:

java.lang.Exception - if can't find the specified metadata or if fails to create a DublinCore document

getDcForIE

DublinCore getDcForIE()
               throws java.lang.Exception

Returns a DublinCore object for the given IE.

Returns:

A DublinCore object representing the IE's descriptive metadata

Throws:

java.lang.Exception - if can't find the specified metadata or if fails to create a DublinCore document

getDnxHelper

DnxDocumentHelper getDnxHelper(java.lang.String pid)
                        throws com.exlibris.digitool.exceptions.DigitoolException

Returns a DnxDocumentHelper object for a given control by its pid.

Parameters:

pid - the control's identifier

Returns:

A DnxDocumentHelper object wrapping a DnxDocument object representing the control's DNX

Throws:

com.exlibris.digitool.exceptions.DigitoolException - if can't find the specified DnxDocument

getDnxHelperForIE

DnxDocumentHelper getDnxHelperForIE()
                             throws com.exlibris.digitool.exceptions.DigitoolException

Returns a DnxDocumentHelper object for the given IE.

Returns:

A DnxDocumentHelper object wrapping a DnxDocument object representing the IE's DNX

Throws:

com.exlibris.digitool.exceptions.DigitoolException - if can't find the specified DnxDocument

getFilesForRep

java.util.List<java.lang.String> getFilesForRep(java.lang.String repPid)
                                         throws com.exlibris.digitool.exceptions.DigitoolException

Returns a list of File identifiers by the given representation pid.

Parameters:

repPid - the representation's identifier

Returns:

A list of file identifiers under the given representation.

Throws:

com.exlibris.digitool.exceptions.DigitoolException

getReps

java.util.List<java.lang.String> getReps()
                                  throws com.exlibris.digitool.exceptions.DigitoolException

Returns a list of representation identifiers for the given IE.

Returns:

A list of representation identifiers under the given IE.

Throws:

com.exlibris.digitool.exceptions.DigitoolException

setDC

void setDC(DublinCore dc,
           java.lang.String pid)

Sets the given DublinCore object for the given control, by its pid.

Parameters:

dc - the given DublinCore object to set

pid - the control's identifier

setDnx

void setDnx(DnxDocumentHelper dnxHelper,
            java.lang.String pid)

Sets the given DnxDocumentHelper object with its DnxDocument for the given control, by its pid.

Parameters:

dnxHelper - the given DnxDocumentHelper to set

pid - the control's identifier

setDCForIE

void setDCForIE(DublinCore dc)

Sets the given DublinCore object for the given IE.

Parameters:

dc - the given DublinCore object to set

setDnxForIE

void setDnxForIE(DnxDocumentHelper dnxHelper)

Sets the given DnxDocumentHelper object with its DnxDocument for the given IE.

Parameters:

dnxHelper - the given DnxDocumentHelper to set

getChangedDnxs

java.util.Map<java.lang.String,DnxDocumentHelper> getChangedDnxs()

Returns a Map consisting of changed pids and their changed DnxDocumentHelper objects. For Interal use only.

Returns:

A Map of changed DnxDocumentHelper objects and their control pid as key.

getChangedDcs

java.util.Map<java.lang.String,DublinCore> getChangedDcs()

Returns a Map consisting of changed pids and their changed DublinCore objects. For Interal use only.

Returns:

A Map of changed DublinCore objects and their control pid as key.

getIEPid

java.lang.String getIEPid()

Returns the identifier of the IE this IEEditor is working on.

Returns:

The IE's pid