|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.remote.crawler.ChildDocument
JavaBean representing the
Constructor Summary | |
ChildDocument()
Default constructor. |
|
ChildDocument(java.lang.String location,
TypeNamespace typeNamespace,
java.lang.String typeID,
java.lang.String displayName)
Valued constructor. |
Method Summary | |
java.lang.String |
getDisplayName()
Gets the display name of the child document. |
java.lang.String |
getLocation()
Gets the location of the child document. |
java.lang.String |
getTypeID()
Gets the TypeID of the child document. |
java.lang.String |
getTypeNameSpace()
Gets the TypeNameSpace of the child document (see typeID ). |
void |
setDisplayName(java.lang.String displayName)
Sets the display name of the child document. |
void |
setLocation(java.lang.String location)
Sets the location of the child document. |
void |
setTypeID(java.lang.String typeId)
Sets the TypeID of the child document. |
void |
setTypeNameSpace(java.lang.String typeNameSpace)
Sets the TypeNameSpace of the child document (see typeID ). |
java.lang.String |
toString()
Returns a human-readable string for debugging. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public ChildDocument()
public ChildDocument(java.lang.String location, TypeNamespace typeNamespace, java.lang.String typeID, java.lang.String displayName)
location
is the string used to retrieve the document in IDocumentProvider.attachToDocument
.
For example, this could be a UNC path for a file crawler,
or a concatenation of database, table, and primary keys for a database crawler, separated by a developer-chosen delimiter.
The location string would then be parsed as required in the developer's implementation of the IDocumentProvider
does not have access to CrawlInfo
, so any crawler values required in
IDocumentProvider.attachToDocument
should be added to the location string to be parsed in that method.
location
- location of the child documenttypeID
- typeID
of the child document. For
TypeNamespace.FILE, this is the filename, for example Proposal.doc. For
TypeNamespace.MIME, this is the MIME type, for example text/html.displayName
- display name of the child documentIDocumentProvider.attachToDocument(java.lang.String, java.lang.String, java.lang.String, com.plumtree.remote.crawler.DocumentFormat)
Method Detail |
public java.lang.String getLocation()
IDocumentProvider.attachToDocument
.
For example, this could be a UNC path for a file crawler,
or a concatenation of database, table, and primary keys for a database crawler, separated by a developer-chosen delimiter.
The location string would then be parsed as required in the developer's implementation of the IDocumentProvider
does not have access to CrawlInfo
, so any crawler values required in
IDocumentProvider.attachToDocument
should be added to the location string to be parsed in that method.
IDocumentProvider.attachToDocument(java.lang.String, java.lang.String, java.lang.String, com.plumtree.remote.crawler.DocumentFormat)
public void setLocation(java.lang.String location)
IDocumentProvider.attachToDocument
.
For example, this could be a UNC path for a file crawler,
or a concatenation of database, table, and primary keys for a database crawler, separated by a developer-chosen delimiter.
The location string would then be parsed as required in the developer's implementation of the IDocumentProvider
does not have access to CrawlInfo
, so any crawler values required in
IDocumentProvider.attachToDocument
should be added to the location string to be parsed in that method.
location
- location of the child document.IDocumentProvider.attachToDocument(java.lang.String, java.lang.String, java.lang.String, com.plumtree.remote.crawler.DocumentFormat)
public java.lang.String getDisplayName()
public void setDisplayName(java.lang.String displayName)
displayName
- display name of the child documentpublic java.lang.String getTypeNameSpace()
TypeNameSpace
of the child document (see typeID
).
TypeNameSpace
of the child documentpublic void setTypeNameSpace(java.lang.String typeNameSpace)
TypeNameSpace
of the child document (see typeID
).
typeNameSpace
- the TypeNameSpace
of the child documentpublic java.lang.String getTypeID()
TypeID
of the child document.
TypeID
of the child documentpublic void setTypeID(java.lang.String typeId)
TypeID
of the child document. If the child document TypeNameSpace
is set to FILE,
the TypeID
should be the same as the display name of the file. If the child document
TypeNameSpace
is set to MIME, the TypeID
should be set to the MIME type of the child document
(for example, "text/html").
typeId
- the TypeID
of the child documentpublic java.lang.String toString()
String
value
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright ©2010 Oracle® Corporation. All Rights Reserved.