Oracle Ultra Search Java API Reference
Release 10g (10.1)

B12028-02
A B C D E F G H I J L N O P Q R S T U W

G

GROUP - Static variable in class oracle.ultrasearch.crawler.AclHelper
 
GUID - Static variable in class oracle.ultrasearch.crawler.AclHelper
 
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.
getAccessUrl() - Method in interface oracle.ultrasearch.crawler.UrlCandidate
Get access url
getAclString() - Method in class oracle.ultrasearch.crawler.AclHelper
Return the ACL string consisting of the current added principals
getAttribute(int) - Method in interface oracle.ultrasearch.crawler.DocumentService
Set the attributes of the document identified by urlId
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(String) - Method in class oracle.ultrasearch.query.InstanceMetaData
Get an attribute using the unique attribute naming scheme.
getAttribute(int) - Method in class oracle.ultrasearch.query.InstanceMetaData
Get an attribute using an attribute ID.
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
getAttributeLOVs(LovInfo) - Method in interface oracle.ultrasearch.crawler.CrawlerAgent
Get the list of values (LOV) for the attributes of this data source
getAttributeLov(int) - Method in interface oracle.ultrasearch.crawler.LovInfo
Get the list of values for a specified attribute
getAttributeName(int) - Method in class oracle.ultrasearch.crawler.DocAttributes
Get the name of the specified attribute
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
getAttributeType(int) - Method in class oracle.ultrasearch.crawler.DocAttributes
Get the data type of the specified attribute
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(int) - Method in class oracle.ultrasearch.crawler.DocAttributes
Get the list of values for a specified attribute
getAttributeValues(int) - Method in interface oracle.ultrasearch.crawler.UrlData
Get the list of values for a specified attribute
getAttributeValues(Attribute) - Method in class oracle.ultrasearch.query.Document
Returns all the values associated with an attribute.
getAttributes() - Method in class oracle.ultrasearch.query.InstanceMetaData
Get all attributes defined in this instance.
getAttributesFetched() - Method in class oracle.ultrasearch.query.Request
get the document attributes to fetch with the result
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.
getAvailableAttributes() - Method in class oracle.ultrasearch.query.Document
Returns a collection of all the attributes available in this document.
getBestLocale(Locale, Set, Locale, Locale) - Static method in class oracle.ultrasearch.query.Util
Calculate the best locale for from a set of candidate locales.
getBoostTerm() - Method in class oracle.ultrasearch.query.Request
get the relevancy boosting term
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.
getContents(int) - Method in interface oracle.ultrasearch.crawler.DocumentService
Get the new contents of the document
getCookies(String, String, String) - Method in interface oracle.ultrasearch.crawler.CrawlerAgent
Deprecated. since 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(Object) - Method in class oracle.ultrasearch.query.AttributeLOV
Get the display name for a value.
getDisplayName(Locale, Locale) - Method in class oracle.ultrasearch.query.InstanceMetaData
Get the display name for a language locale.
getDisplayName(Attribute, Locale) - Method in class oracle.ultrasearch.query.InstanceMetaData
Get the display name for an Attribute.
getDisplayName(Attribute, Locale, boolean) - Method in class oracle.ultrasearch.query.InstanceMetaData
Get the display name for an Attribute, using a lookup method that starts with one specific locale, then progressively fallbacks to more general locales.
getDisplayName(Group, Locale) - Method in class oracle.ultrasearch.query.InstanceMetaData
Get the display name for a Group.
getDisplayName(Group, Locale, boolean) - Method in class oracle.ultrasearch.query.InstanceMetaData
Get the display name for a Group, using a lookup method that starts with one specific locale, then progressively fallbacks to more general locales.
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
getDocLanguage() - Method in class oracle.ultrasearch.query.Request
get the document language to limit the search.
getDocsRequested() - Method in class oracle.ultrasearch.query.Request
get the number of documents to fetch
getEllipsisMark() - Method in class oracle.ultrasearch.query.Request
get the ellipsis marking used for excerpt computation.
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.
getEndTag() - Method in class oracle.ultrasearch.query.Request
get the highlighting end tag The highlighting tag is used to highlight string attribute values and the document's excerpt.
getErrorCode() - Method in class oracle.ultrasearch.query.SearchException
 
getErrorString() - Method in class oracle.ultrasearch.crawler.AgentException
returns the error message
getExcerpt() - Method in class oracle.ultrasearch.query.Document
Return an excerpt of the document, with keywords highlighted.
getExcerptLength() - Method in class oracle.ultrasearch.query.Request
get the length of the document excerpt to compute
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.
getFilter() - Method in class oracle.ultrasearch.query.Request
get the filtering condition on the result.
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.
getHiliteAttribute(StringAttribute) - Method in class oracle.ultrasearch.query.Document
return the highlighted attribute value for a string attribute.
getHiliteAttributeValues(StringAttribute) - Method in class oracle.ultrasearch.query.Document
return the highlighted attribute values for a string attribute.
getHiliteAttributes() - Method in class oracle.ultrasearch.query.Document
return all the attributes that are highlighted in this document.
getHiliteAttributes() - Method in class oracle.ultrasearch.query.Request
get the list of string attributes to highlight
getId() - Method in class oracle.ultrasearch.query.Attribute
Get the attribute's id
getId() - Method in class oracle.ultrasearch.query.Document
Get the document 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.
getLOVDefault(Attribute, Locale) - Method in class oracle.ultrasearch.query.InstanceMetaData
Get the attribute LOV available for this attribute.
getLOVDefault(Attribute, Locale, boolean) - 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.
getLOVIntersect(Attribute, Group[], Locale, boolean) - 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.
getLOVUnion(Attribute, Group[], Locale, boolean) - 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.
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.
getLocaleFallbacks(Locale, Locale) - Static method in class oracle.ultrasearch.query.Util
Calculate the search path from a specific locale (orig) to its parent locales, then to the default locale (def), and finally to the default locale's parent locales.
getLocalizedMessage() - Method in class oracle.ultrasearch.query.SearchException
 
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.
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.
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.Attribute
Get the attribute's name
getName() - Method in class oracle.ultrasearch.query.EmailSource
Gets the email data source name
getName() - Method in class oracle.ultrasearch.query.Group
Get the group's name
getNumAttrValues() - Method in class oracle.ultrasearch.crawler.DocAttributes
Get number of attribute values
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
getNumAttributes() - Method in class oracle.ultrasearch.crawler.DocAttributes
Get number of attributes
getNumAttributes() - Method in interface oracle.ultrasearch.crawler.LovInfo
Get number of attributes
getNumAttributes() - Method in interface oracle.ultrasearch.crawler.UrlData
Get number of attributes
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
getNumberAttribute(String) - Method in class oracle.ultrasearch.query.InstanceMetaData
Get a number attribute from Ultra Search using an attribute name (not display name).
getParameter(String) - Method in interface oracle.ultrasearch.crawler.DataSourceParams
Get parameter value
getProperty(int) - Method in class oracle.ultrasearch.crawler.DocAttributes
Get the value of an URL data property
getProperty(int) - Method in interface oracle.ultrasearch.crawler.UrlData
Get the value of an URL data property
getQuery() - Method in class oracle.ultrasearch.query.Request
get the query clause of request
getQueryLanguage() - Method in class oracle.ultrasearch.query.Request
get the language of the query
getRefreshInterval() - Method in class oracle.ultrasearch.query.Instance
Gets the interval by which meta data is refreshed.
getRequest() - Method in class oracle.ultrasearch.query.Result
return the request this result is for.
getResult(Request) - Method in class oracle.ultrasearch.query.Instance
Get the result for a search request.
getResult(Query, Locale, int, int, Locale, Attribute[], String, boolean) - Method in class oracle.ultrasearch.query.Instance
Deprecated.  
getResult(Query, Locale, int, int, Locale, Attribute[], String, boolean, boolean) - Method in class oracle.ultrasearch.query.Instance
Deprecated.  
getRobotControl(int) - Method in interface oracle.ultrasearch.crawler.DocumentService
Get the attributes of the document identified by urlId
getScore() - Method in class oracle.ultrasearch.query.Document
Returns the value of the hit score.
getSearchUser() - Method in class oracle.ultrasearch.query.JaznUserManager
 
getSearchUser() - Method in class oracle.ultrasearch.query.UserManager
 
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.
getStartIndex() - Method in class oracle.ultrasearch.query.Request
get the start index of the range of documents to fetch.
getStartTag() - Method in class oracle.ultrasearch.query.Request
get the highlighting start tag The highlighting tag is used to highlight string attribute values and the document's excerpt.
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.DateAttribute
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.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.
getUserManager() - Method in class oracle.ultrasearch.query.Instance
Gets the user manager used.
getValues() - Method in class oracle.ultrasearch.query.AttributeLOV
Get the values in this LOV.
getVersion() - Method in class oracle.ultrasearch.query.Instance
Return the product internal version from the Ultra Search Database.
getVersion() - Static method in class oracle.ultrasearch.query.Util
Get the version of the Java Query API.

Oracle Ultra Search Java API Reference
Release 10g (10.1)

B12028-02
A B C D E F G H I J L N O P Q R S T U W
Copyright © 2004 Oracle Corporation. All Rights Reserved.