|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTAccessor
An IPTAccessor is an external component that knows how to parse a particular type of document and return metadata found in the document
IPTDataSourceProvider
Method Summary | |
---|---|
void |
AttachToDocument(com.plumtree.openfoundation.util.IXPPropertyBag pBagDocumentLocation,
IPTSession pSession)
Attaches this Accessor to the document identified by information in the PropertyBag |
java.lang.String |
DocumentSummary()
Returns a human readable summary of the document |
java.lang.String |
GetAccessorCLSID()
Returns the CLSID associated with this accessor |
java.lang.Object[][] |
GetCommonFields()
Returns names and descriptions of fields that are commonly returned from GetFields, for use in a mapping UI. |
java.lang.String |
GetDescription()
Returns a description of this Accessor |
java.lang.String |
GetDocumentImageUUID()
Returns the UUID for the image that should be used to represent the document in the UI |
int |
GetDocumentLocationFormatID()
Each Accessor knows how to deal with a particular format of document (for example, some Accessors parse files, while others know how to extract metadata from Lotus Notes.) This identifier documents the type of document that this Accessor knows how to deal with. |
java.lang.Object[][] |
GetFields()
Returns a 2D array containing the metadata found in the document. |
java.lang.String |
GetFileExtension()
Returns the file extension (e.g. |
java.lang.String |
GetImageUUID()
Returns the UUID for the image that's used to represent this Accessor in the UI |
java.lang.String |
GetName()
Returns the name of this Accessor |
java.lang.String |
GetSuggestedCardName()
Returns a suggested name for the Card to be made, which is typically generated from a field in the document |
java.lang.Object[][] |
GetSuggestedDocumentTypeMapEntries()
Returns suggested entries for the Document Type Map. |
java.lang.String |
GetURLInfo()
Returns additional URL info that helps the UI perform clickthrough on the document |
int |
QueryCapability(int QueryCapability)
Used to determine if the Accessor supports certain operations. |
void |
WriteIndexingFile(java.lang.String sFullFilePath)
Writes an indexing file to the specified path. |
Method Detail |
---|
void AttachToDocument(com.plumtree.openfoundation.util.IXPPropertyBag pBagDocumentLocation, IPTSession pSession)
pBagDocumentLocation
- the location of the document. The
information contained in this PropertyBag may vary depending on the
repository type. For example, files on the file system are identified by
UNC path, while Notes within a Lotus Notes database are identified by
NoteID.pSession
- the Plumtree session of the current userjava.lang.Object[][] GetFields()
java.lang.String GetDocumentImageUUID()
java.lang.String GetURLInfo()
java.lang.String GetFileExtension()
void WriteIndexingFile(java.lang.String sFullFilePath)
sFullFilePath
- the path to which the file should be writtenjava.lang.String DocumentSummary()
java.lang.String GetSuggestedCardName()
java.lang.String GetName()
java.lang.String GetDescription()
java.lang.String GetAccessorCLSID()
int QueryCapability(int QueryCapability)
QueryCapability
- a value from PT_ACCESSOR_CAPABILITIES
java.lang.Object[][] GetCommonFields()
java.lang.String GetImageUUID()
int GetDocumentLocationFormatID()
java.lang.Object[][] GetSuggestedDocumentTypeMapEntries()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |