|
Oracle Fusion Applications Search Java API Reference for Oracle Enterprise Crawl and Search Framework
11g Release 1 (11.1.1.6) E21908-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Document
An document represents an instance of a searchable object.
Method Summary | |
---|---|
void |
addChildDoc(java.lang.String name,
Document doc)
Adds a child indexable document. |
void |
addField(FieldDefinition field,
java.lang.Object value)
Adds a name/value pair as a unstored field. |
void |
addTags(java.lang.String[] tags)
Adds a list of tags to this document. |
void |
clearTags()
Clears tags added to this document. |
java.util.Map |
getAttributes()
Returns fields map hashed against attribute name. |
Document[] |
getChildDocs(java.lang.String name)
Gets a child indexable document by name. |
java.lang.String |
getContent()
Returns content assigned to this document. |
java.lang.String |
getContentType()
Returns mContent type for this document. |
java.lang.String |
getDisplayURL()
Returns a url that uniquely identifies the document in a search engine instance. |
DocumentDefinition |
getDocumentDefinition()
Gets document definition of this document. |
java.util.Map |
getFields()
Returns fields map hashed against field binding. |
java.lang.Object |
getFieldValue(java.lang.String name)
Returns a field value from result for a given name. |
java.lang.String |
getKeywords()
Returns keywords of this document. |
java.lang.String |
getLanguage()
Returns the language code for the document |
PrimaryKey |
getPrimaryKey()
Gets primaryKey of this document. |
SearchableObject |
getSearchableObject()
Gets meta data definition for this document. |
java.util.List<java.lang.String> |
getTags()
Returns a list of tags attached to this document. |
java.lang.String |
getTitle()
Returns title of this document. |
void |
removeChildDocs()
Removes all child indexable documents (when no longer needed). |
void |
setContent(java.lang.String content)
Sets content for this document. |
void |
setContentType(java.lang.String contentType)
Sets contentType for this document. |
void |
setDocumentDefinition(DocumentDefinition docDef)
Sets the document definition. |
void |
setFieldValue(java.lang.String attributeName,
java.lang.Object attributeValue)
Sets attribute value. |
void |
setKeywords(java.lang.String keywords)
Sets keywords. |
void |
setLanguage(java.lang.String language)
Sets the language for the Document |
void |
setPrimaryKey(PrimaryKey pk)
Sets primaryKey for this document; |
void |
setTitle(java.lang.String title)
Sets title. |
Method Detail |
---|
void addField(FieldDefinition field, java.lang.Object value)
field
- value
- java.util.Map getFields()
java.util.Map getAttributes()
java.lang.Object getFieldValue(java.lang.String name)
name
- field name.
PrimaryKey getPrimaryKey()
void setPrimaryKey(PrimaryKey pk)
pk
- java.lang.String getContentType()
void setContentType(java.lang.String contentType)
contentType
- new conent.java.lang.String getContent()
void setContent(java.lang.String content)
content
- new conent.SearchableObject getSearchableObject()
void setFieldValue(java.lang.String attributeName, java.lang.Object attributeValue)
attributeName
- name of the attribute.attributeValue
- new value for the attribute.java.lang.String getLanguage()
void setLanguage(java.lang.String language)
language
- default language of this document.java.lang.String getDisplayURL()
java.lang.String getTitle()
void setTitle(java.lang.String title)
title
- new title.java.lang.String getKeywords()
void setKeywords(java.lang.String keywords)
keywords
- new keywords.void addChildDoc(java.lang.String name, Document doc)
Document[] getChildDocs(java.lang.String name)
void removeChildDocs()
DocumentDefinition getDocumentDefinition()
void setDocumentDefinition(DocumentDefinition docDef)
docDef
- void addTags(java.lang.String[] tags)
tags
- a list of tags.java.util.List<java.lang.String> getTags()
void clearTags()
|
Oracle Fusion Applications Search Java API Reference for Oracle Enterprise Crawl and Search Framework
11g Release 1 (11.1.1.6) E21908-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |