Class Overview
DocumentAccessProvider implementation to open a document using the original path
and translating the path to a representation resolvable for renderer processing
the document referred by this DocumentAccessProvider.
We assume, that the document is accessible for the JVM running the rendering
library and all renderer instances possibly processing the
document referred by this DocumentAccessProvider, but the renderer requires
another path representation (e.g. add prefix for drive, IP address...).
Summary
Public Constructors |
|
OpenInPlaceTranslated(Path path, String localPrefix, String remotePrefix)
Constructs a new OpenInPlaceTranslated provider.
|
Public Methods |
String
|
getResolvedPath()
Gets the path with replacements as specified with #localPrefix and #remotePrefix
|
[Expand]
Inherited Methods |
From class
com.priint.comet.renderer.io.providers.OpenInPlace
void
|
beforeOpen(Configuration configuration)
Prepares the document for processing with a renderer
Called before document is opened by a renderer.
|
Class<? extends DocumentType>
|
getDocumentType()
Gets the type of the document referred by this DocumentAccessProvider
Gets the type of the document referred by this DocumentAccessProvider,
e.g.
|
Path
|
getLocalPath()
Gets the local path of the document referred by this DocumentAccessProvider.
|
String
|
getResolvedPath()
Gets the path as passed to the renderer
Gets the document path as passed to the renderer.
|
|
From class
java.lang.Object
Object
|
clone()
|
boolean
|
equals(Object arg0)
|
void
|
finalize()
|
final
Class<?>
|
getClass()
|
int
|
hashCode()
|
final
void
|
notify()
|
final
void
|
notifyAll()
|
String
|
toString()
|
final
void
|
wait(long arg0, int arg1)
|
final
void
|
wait(long arg0)
|
final
void
|
wait()
|
|
From interface
com.priint.comet.renderer.io.DocumentAccessProvider
abstract
void
|
afterClose(OpenedDocument document, long fileSystemPropagationDelayMillis, long fileSystemPropagationProbeMillis)
Cleans up after document processing has finished
Called, after a document has been closed by the renderer.
|
abstract
void
|
beforeOpen(Configuration configuration)
Prepares the document for processing with a renderer
Called before document is opened by a renderer.
|
abstract
void
|
fetchResource(String localPath)
|
abstract
Class<? extends DocumentType>
|
getDocumentType()
Gets the type of the document referred by this DocumentAccessProvider
Gets the type of the document referred by this DocumentAccessProvider,
e.g.
|
abstract
Path
|
getLocalPath()
Gets the local path of the document referred by this DocumentAccessProvider.
|
abstract
String
|
getResolvedPath()
Gets the path as passed to the renderer
Gets the document path as passed to the renderer.
|
abstract
void
|
putResource(String localPath)
Makes document resources available for the renderer
Makes document resources available for the renderer.
|
|
Public Constructors
public
OpenInPlaceTranslated
(Path path, String localPrefix, String remotePrefix)
Constructs a new OpenInPlaceTranslated provider.
Constructs a new OpenInPlaceTranslated provider.
The localPrefix
part of the (local) representation
of the document part is replaced by remorePrefix
.
Example:
If the local path of the document is /usr/shared/documents/mydocument.indd
,
localPrefix is set to "/usr/shared/documents/"
and
remotePrefix is set to "\\192.168.17.6\documents\"
, the
resolved path passed to the renderer is "\\192.168.17.6\documents\mydocument.indd"
Parameters
path |
path denoting the file to be opened |
localPrefix |
this part at the beginning of the local path presentation is replaced by remotePrefix |
remotePrefix |
String to be inserted at the beginning of the string truncated by localPrefix
|
Public Methods
public
String
getResolvedPath
()
Gets the path with replacements as specified with #localPrefix and #remotePrefix
Returns
- path resolvable for the renderer processing this document