|
Oracle Secure Enterprise Search Java API Reference 11g Release 1 (11.1.2.0.0) E14433-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DocumentMetadata
DocumentMetadata is an interface used by a crawler plug-in to submit URL-related data to the crawler.
Field Summary | |
---|---|
static int |
ATTR_TYPE_DATE Date attribute data type |
static int |
ATTR_TYPE_NUMBER Number attribute data type |
static int |
ATTR_TYPE_STRING String attribute data type |
Method Summary | |
---|---|
void |
addAttribute(String name, BigDecimal value) Adds an attribute value whose data type is Number |
void |
addAttribute(String name, Date value) Adds an attribute value whose data type is java.util.Date . |
void |
addAttribute(String name, String value) Adds an attribute value whose type is String |
void |
clearData() Clears all metadata of this document |
void |
deleteAttribute(String name) Deletes the specified attribute |
String |
getAccessURL() Gets the value of an access URL document property. |
DocumentAcl |
getACLInfo() Gets the access control information associated with the document. |
String |
getAttributeName(int attrIndex) Gets the name of the specified attribute |
int |
getAttributeType(int attrIndex) Gets the data type of the specified attribute |
Enumeration |
getAttributeValues(int attrIndex) Get the list of values for a specified attribute |
Enumeration |
getAttributeValues(String attrName) Gets the list of values for a specified attribute |
int |
getContentLength() Returns the actual document content size in bytes. |
String |
getContentType() Gets the document content type. |
int |
getCrawlDepth() Gets the crawling depth of the document. |
String |
getDisplayURL() Gets the value of a URL data property. |
String |
getLanguage() Gets the ISO 639-1 language code of the document. |
int |
getLastDocumentStatus() Gets the document status of the previous crawl |
Date |
getLastModifiedDate() Gets the last modification date of the document |
int |
getNumAttributes() Gets the number of attributes |
int |
getNumAttrValues() Gets the number of attribute values |
String |
getOwnerGuid() Gets the owner principal of the document. |
String[] |
getSourceHierarchy() Gets the source hierarchy of the document |
void |
setAccessURL(String value) Sets the access URL property. |
void |
setACLInfo(DocumentAcl acl) Sets the document ACL. |
void |
setAffinity(String value) Sets the document affinity value for duplicate detection. |
void |
setAttributes(String name, BigDecimal[] values) Sets or replaces a list of attribute values whose data type is Number |
void |
setAttributes(String name, Date[] values) Sets or replaces a list of attribute values whose data type is java.util.Date . |
void |
setAttributes(String name, String[] values) Sets or replaces a list of attribute values whose data type is String |
void |
setContentLength(int size) Sets the size of the document. |
void |
setContentType(String mimeType) Sets the content type of the document. |
void |
setCrawlDepth(int depth) Sets the crawling depth of the document. |
void |
setDisplayURL(String value) Sets the display URL property |
void |
setLanguage(String value) Sets the language of the document using ISO 639-1 language code; for example, 'en' for English, 'ja' for Japanese, and 'fr' for French |
void |
setLastModifiedDate(Date timeStamp) Sets the last modification date of the document |
void |
setOwnerGuid(String ownerGuid) Sets the document owner. |
void |
setSourceHierarchy(String[] hierarchyList) Sets the path of the document in terms of information source organization. |
Field Detail |
---|
static final int ATTR_TYPE_STRING
static final int ATTR_TYPE_NUMBER
static final int ATTR_TYPE_DATE
Method Detail |
---|
void setDisplayURL(String value)
value
- the display URL property valueString getDisplayURL()
null
if there is no such propertyvoid setAccessURL(String value)
value
- the access URL property valueString getAccessURL()
null
void setAffinity(String value)
value
- the affinity stringvoid setContentType(String mimeType)
mimeType
- the document key valueString getContentType()
void setCrawlDepth(int depth)
depth
- the crawling depth of the documentint getCrawlDepth()
void setLanguage(String value)
value
- the ISO 639-1 language codeString getLanguage()
void setSourceHierarchy(String[] hierarchyList)
[hardware][power tools][sanders]
for a URL path /hardware/power%20tools/sanders
hierarchyList
- the hierarchy list from top to bottomString[] getSourceHierarchy()
void setLastModifiedDate(Date timeStamp)
timeStamp
- the last modification dateDate getLastModifiedDate()
void setACLInfo(DocumentAcl acl)
DocumentAcl
object.acl
- the ACL or set of security attribute values protecting the document; if null
, no access control information is associated with this documentDocumentAcl getACLInfo()
null
if there is no security information associated with this documentvoid setOwnerGuid(String ownerGuid)
ownerGuid
- the owner principal, in the format of the canonical attributeIdentityPluginManager.getCanonicalAttribute()
String getOwnerGuid()
int getLastDocumentStatus()
void addAttribute(String name, BigDecimal value)
name
- the name of the attributevalue
- the value of the attributevoid addAttribute(String name, Date value)
java.util.Date
. Note that java.util.Date
has a time component.name
- the name of the attributevalue
- the value of the attributevoid addAttribute(String name, String value)
String
name
- the name of the attributevalue
- the value of the attributevoid setAttributes(String name, BigDecimal[] values)
name
- the name of the attributevalues
- an array of attribute values, at least one value existsvoid setAttributes(String name, Date[] values)
java.util.Date
. Note that java.util.Date
has a time componentname
- the name of the attributevalues
- - an array of attribute values, at least one value existsvoid setAttributes(String name, String[] values)
String
name
- the name of the attributevalues
- an array of attribute values, at least one value existsvoid deleteAttribute(String name)
name
- the name of the attributeint getNumAttributes()
int getNumAttrValues()
String getAttributeName(int attrIndex)
attrIndex
- 0-based index indicating which attribute to returnint getAttributeType(int attrIndex)
attrIndex
- - a 0-based index indicating which attribute to returnATTR_TYPE_NUMBER
, ATTR_TYPE_STRING
, or ATTR_TYPE_DATE
.Enumeration getAttributeValues(int attrIndex)
attrIndex
- 0-based index indicating which attributeEnumeration getAttributeValues(String attrName)
attrName
- the name of the attributevoid clearData()
void setContentLength(int size)
size
- size of the document in bytesint getContentLength()
|
Oracle Secure Enterprise Search Java API Reference 11g Release 1 (11.1.2.0.0) E14433-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |