Overview
Package
Class
Use
Tree
Index
Help
Oracle Ultra Search Java API Reference
9.0.3
PREV LETTER
NEXT LETTER
FRAMES
NO FRAMES
A
B
C
D
E
F
G
H
I
L
N
O
P
Q
R
S
T
U
W
G
getAccessUrl()
- Method in interface oracle.ultrasearch.crawler.
UrlCandidate
Get access url
getAttribute()
- Method in class oracle.ultrasearch.query.
AttributeLOV
Get the attribute associated with this LOV.
getAttribute(Attribute)
- Method in class oracle.ultrasearch.query.
Document
Returns a value associated with an attribute.
getAttribute(int)
- Method in class oracle.ultrasearch.query.
InstanceMetaData
Get an attribute using an attribute ID.
getAttribute(String)
- Method in class oracle.ultrasearch.query.
InstanceMetaData
Get an attribute using the unique attribute naming scheme.
getAttribute(String, Class)
- Method in class oracle.ultrasearch.query.
InstanceMetaData
Get an attribute from Ultra Search using an attribute name (not display name), and type
getAttributeLov(int)
- Method in interface oracle.ultrasearch.crawler.
LovInfo
Get the list of values for a specified attribute
getAttributeLOVs(LovInfo)
- Method in interface oracle.ultrasearch.crawler.
CrawlerAgent
Get the list of values (LOV) for the attributes of this data source
getAttributeName(int)
- Method in interface oracle.ultrasearch.crawler.
LovInfo
Get the name of the specified attribute
getAttributeName(int)
- Method in interface oracle.ultrasearch.crawler.
UrlData
Get the name of the specified attribute
getAttributes()
- Method in class oracle.ultrasearch.query.
InstanceMetaData
Get all attributes defined in this instance.
getAttributesIntersect(Group[])
- Method in class oracle.ultrasearch.query.
InstanceMetaData
Get the attributes available in a set of data group by finding the intersection of each group's attributes.
getAttributesUnion(Group[])
- Method in class oracle.ultrasearch.query.
InstanceMetaData
Get the attributes available in a set of data groups by finding the union of each group's attributes.
getAttributeType(int)
- Method in interface oracle.ultrasearch.crawler.
LovInfo
Get the data type of the specified attribute
getAttributeType(int)
- Method in interface oracle.ultrasearch.crawler.
UrlData
Get the data type of the specified attribute
getAttributeValues(Attribute)
- Method in class oracle.ultrasearch.query.
Document
Returns all the values associated with an attribute.
getAttributeValues(int)
- Method in interface oracle.ultrasearch.crawler.
UrlData
Get the list of values for a specified attribute
getAvailableAttributes()
- Method in class oracle.ultrasearch.query.
Document
Returns a collection of all the attributes available in this document.
getCandidateUrl()
- Method in interface oracle.ultrasearch.crawler.
UrlCandidate
Get target url string for rewrite checking
getConnection()
- Method in class oracle.ultrasearch.query.
Instance
Get the Connection object used to connect to this instance.
getConnection()
- Method in class oracle.ultrasearch.query.
QueryInstance
Get a Connection object using a connection pool.
getConnectionString()
- Method in class oracle.ultrasearch.query.
QueryInstance
Get the JDBC connection string used to create a connection
getContentLength()
- Method in class oracle.ultrasearch.query.
Document
Returns document content length.
getCookies(String, String, String)
- Method in interface oracle.ultrasearch.crawler.
CrawlerAgent
Get the cookie string of the specified URL; not supported in 9.0.2
getCredential(String, String, String)
- Method in interface oracle.ultrasearch.crawler.
CrawlerAgent
Get the user name and password of the specified URL
getDataSourceName()
- Method in class oracle.ultrasearch.query.
QueryInstance
Get a JNDI name of the data source being used.
getDate()
- Method in class oracle.ultrasearch.query.
EmailHeader
Gets the 'DATE' field of the email message
getDateAttribute(String)
- Method in class oracle.ultrasearch.query.
InstanceMetaData
Get a date attribute from Ultra Search using an attribute name (not display name).
getDescription()
- Method in class oracle.ultrasearch.query.
EmailSource
Gets the description of this email data source
getDisplayName(Attribute, Locale)
- Method in class oracle.ultrasearch.query.
InstanceMetaData
Get the display name for an Attribute.
getDisplayName(Group, Locale)
- Method in class oracle.ultrasearch.query.
InstanceMetaData
Get the display name for a Group.
getDisplayName(Object)
- Method in class oracle.ultrasearch.query.
AttributeLOV
Get the display name for a value.
getDisplayNames(int, int)
- Method in interface oracle.ultrasearch.crawler.
LovInfo
Get the list of display names for a specified attribute
getDisplayNames(Object)
- Method in class oracle.ultrasearch.query.
AttributeLOV
Get all the display names for a value.
getDisplayUrl()
- Method in interface oracle.ultrasearch.crawler.
UrlCandidate
Get display url
getEmailHeader(int, int)
- Method in class oracle.ultrasearch.query.
EmailUtil
Gets the header information of an email.
getEmailHeaders(int, int, int)
- Method in class oracle.ultrasearch.query.
EmailUtil
Gets header information of a number of email messages
getEmailSource(int)
- Method in class oracle.ultrasearch.query.
EmailUtil
Gets one email source
getEmailSources()
- Method in class oracle.ultrasearch.query.
EmailUtil
Gets a list of email sources that are defined in the Oracle Ultra Search instance.
getErrorCode()
- Method in class oracle.ultrasearch.query.
SearchException
getErrorString()
- Method in class oracle.ultrasearch.crawler.
AgentException
returns the error message
getFilePagePath()
- Method in class oracle.ultrasearch.query.
Instance
Gets the URL path of the web application (JSP or Servlet) that will render the contents of a file.
getFrom()
- Method in class oracle.ultrasearch.query.
EmailHeader
Gets the 'FROM' field of the email message
getGroup(int)
- Method in class oracle.ultrasearch.query.
InstanceMetaData
Get a group using its ID.
getGroup(String)
- Method in class oracle.ultrasearch.query.
InstanceMetaData
Get a group using its name.
getGroups()
- Method in class oracle.ultrasearch.query.
Document
Returns the groups this document belongs to.
getGroups()
- Method in class oracle.ultrasearch.query.
InstanceMetaData
Get all the groups defined in the instance.
getId()
- Method in class oracle.ultrasearch.query.
Document
Get the document id.
getId()
- Method in class oracle.ultrasearch.query.
Attribute
Get the attribute's id
getId()
- Method in class oracle.ultrasearch.query.
Group
Get the group's id
getInstance()
- Method in class oracle.ultrasearch.query.
InstanceMetaData
get the Instance object that created this instance meta data.
getInstanceName()
- Method in class oracle.ultrasearch.query.
Instance
Get the instance name is used.
getLangCode(int, int)
- Method in interface oracle.ultrasearch.crawler.
LovInfo
Get the language-country code string for a display name
getLanguage()
- Method in class oracle.ultrasearch.query.
Document
Returns the document's language.
getLanguages()
- Method in class oracle.ultrasearch.query.
InstanceMetaData
Get all the searchable languages defined in this instance.
getLastModified()
- Method in class oracle.ultrasearch.query.
Document
Returns date of the last modification on this document.
getLocalizedMessage()
- Method in class oracle.ultrasearch.query.
SearchException
getLOVDefault(Attribute, Locale)
- Method in class oracle.ultrasearch.query.
InstanceMetaData
Get the attribute LOV available for this attribute.
getLOVIntersect(Attribute, Group[], Locale)
- Method in class oracle.ultrasearch.query.
InstanceMetaData
Get the attribute LOV available for this set of groups by finding the intersection of the individual group's LOV.
getLOVUnion(Attribute, Group[], Locale)
- Method in class oracle.ultrasearch.query.
InstanceMetaData
Get the attribute LOV available for this set of groups by finding the union of the individual group's LOV.
getMailPagePath()
- Method in class oracle.ultrasearch.query.
Instance
Gets the URL path of the web application (JSP or Servlet) that will render the contents of an email.
getMailPagePath()
- Method in class oracle.ultrasearch.query.
EmailUtil
Gets the URL path of the web application (JSP or Servlet) that will render the contents of an email.
getMessage()
- Method in class oracle.ultrasearch.query.
SearchException
getMessageCount(int)
- Method in class oracle.ultrasearch.query.
EmailUtil
Gets the number of messages in an email source.
getMetaData()
- Method in class oracle.ultrasearch.query.
Instance
Get the meta data associated with the query instance.
getMimeMessage(int, int)
- Method in class oracle.ultrasearch.query.
EmailUtil
Gets an email message as a javax.mail.internet.MimeMessage object.
getName()
- Method in class oracle.ultrasearch.query.
EmailSource
Gets the email data source name
getName()
- Method in class oracle.ultrasearch.query.
Attribute
Get the attribute's name
getName()
- Method in class oracle.ultrasearch.query.
Group
Get the group's name
getNumAttributes()
- Method in interface oracle.ultrasearch.crawler.
LovInfo
Get number of attributes
getNumAttributes()
- Method in interface oracle.ultrasearch.crawler.
UrlData
Get number of attributes
getNumAttrValues()
- Method in interface oracle.ultrasearch.crawler.
LovInfo
Get number of attribute values
getNumAttrValues()
- Method in interface oracle.ultrasearch.crawler.
UrlData
Get number of attribute values
getNumberAttribute(String)
- Method in class oracle.ultrasearch.query.
InstanceMetaData
Get a number attribute from Ultra Search using an attribute name (not display name).
getNumDisplayNames(int, int)
- Method in interface oracle.ultrasearch.crawler.
LovInfo
Get number of display names of an attribute for a language
getNumLanguages(int)
- Method in interface oracle.ultrasearch.crawler.
LovInfo
Get number of languages used for the display name of an attribute
getParameter(String)
- Method in interface oracle.ultrasearch.crawler.
DataSourceParams
Get parameter value
getProperty(int)
- Method in interface oracle.ultrasearch.crawler.
UrlData
Get the value of an URL data property
getRefreshInterval()
- Method in class oracle.ultrasearch.query.
Instance
Gets the interval by which meta data is refreshed.
getResult(Query, Locale, int, int, Locale, Attribute[], String, boolean)
- Method in class oracle.ultrasearch.query.
Instance
Get the result for a query.
getScore()
- Method in class oracle.ultrasearch.query.
Document
Returns the value of the hit score.
getSeqNum()
- Method in class oracle.ultrasearch.query.
EmailHeader
Gets the sequence number of the email message
getSignature()
- Method in class oracle.ultrasearch.query.
Document
Get the signature of the document.
getSourceId()
- Method in class oracle.ultrasearch.query.
EmailSource
Gets the email data source id.
getStringAttribute(String)
- Method in class oracle.ultrasearch.query.
InstanceMetaData
Get a string attribute from Ultra Search using an attribute name (not display name).
getSubject()
- Method in class oracle.ultrasearch.query.
EmailHeader
Gets the 'SUBJECT' field of the email message
getTablePagePath()
- Method in class oracle.ultrasearch.query.
Instance
Gets the URL path of the web application (JSP or Servlet) that will render the contents of a table row cell.
getUniqueName()
- Method in class oracle.ultrasearch.query.
Attribute
Get the attribute's unique name.
getUniqueName()
- Method in class oracle.ultrasearch.query.
NumberAttribute
Get the attribute's unique name.
getUniqueName()
- Method in class oracle.ultrasearch.query.
DateAttribute
Get the attribute's unique name.
getUniqueName()
- Method in class oracle.ultrasearch.query.
StringAttribute
Get the attribute's unique name.
getUrl()
- Method in class oracle.ultrasearch.query.
Document
Returns the display URL of the document.
getUser()
- Method in class oracle.ultrasearch.query.
QueryInstance
Get the database username of the Ultra Search instance that should be accessed.
getValues()
- Method in class oracle.ultrasearch.query.
AttributeLOV
Get the values in this LOV.
getVersion()
- Static method in class oracle.ultrasearch.query.
Util
Get the version of the Java Query API.
GreaterThan
- class oracle.ultrasearch.query.
GreaterThan
.
Class GreaterThan narrows the attribute to bigger values.
GreaterThan(DateAttribute, Date)
- Constructor for class oracle.ultrasearch.query.
GreaterThan
Construct a GreaterThan query on a DateAttribute.
GreaterThan(NumberAttribute, BigDecimal)
- Constructor for class oracle.ultrasearch.query.
GreaterThan
Construct a GreaterThan query on a NumberAttribute.
Group
- class oracle.ultrasearch.query.
Group
.
Class Group represent an abstract collection of documents.
Overview
Package
Class
Use
Tree
Index
Help
Oracle Ultra Search Java API Reference
9.0.3
PREV LETTER
NEXT LETTER
FRAMES
NO FRAMES
A
B
C
D
E
F
G
H
I
L
N
O
P
Q
R
S
T
U
W