A B C D E F G H I L N O P R S T U V

A

add(SearchEntry) - Method in class org.exoplatform.commons.api.indexing.IndexingService

Add entry

addConnector(SearchServiceConnector) - Method in class org.exoplatform.commons.api.search.SearchService

Add a connector that implemented search API

addEventListener(Listener<S, D>) - Method in interface org.exoplatform.commons.api.event.EventManager

This will be used to register a listener to the event system.

addEventListener(String, Listener<S, D>) - Method in interface org.exoplatform.commons.api.event.EventManager

This will be used to register a listener to the event system.

B

BaseObject - Interface in org.exoplatform.commons.api.event.data

This Object will be used to get information from a JCR node instead of open a direct access to javax.jcr.Node object.

broadcastEvent(Event<S, D>) - Method in interface org.exoplatform.commons.api.event.EventManager

When an action triggered such as file created/updated then it will be broadcast to the dedicated listener to dispatch the event.

buildContextPath(Context) - Static method in class org.exoplatform.commons.api.settings.data.Tools

Build path to a specified context in database

buildFullPath(Context, Scope, String) - Static method in class org.exoplatform.commons.api.settings.data.Tools

Build path of a specified setting property stored in database

buildScopePath(Context, Scope) - Static method in class org.exoplatform.commons.api.settings.data.Tools

Build the path to a specified scope in database

C

collection - Variable in class org.exoplatform.commons.api.indexing.data.SearchEntryId

content - Variable in class org.exoplatform.commons.api.indexing.data.SearchEntry

Context - Enum in org.exoplatform.commons.api.settings.data

This class allow a user to be able to save some settings linked to a Context.

context - Variable in class org.exoplatform.commons.api.settings.data.SettingContext

ContextPath - Variable in class org.exoplatform.commons.api.settings.data.SettingContext

path of context in jcr

create(Event<S, D>) - Method in interface org.exoplatform.commons.api.event.EventListener

Process the dedicated work when the create event has been triggered.

create() - Method in enum org.exoplatform.commons.api.search.data.SearchContext.RouterParams

Create qualified name

create(String) - Static method in class org.exoplatform.commons.api.settings.SettingValue

create setting value object of type String

create(Long) - Static method in class org.exoplatform.commons.api.settings.SettingValue

create setting value object of type Long

create(Double) - Static method in class org.exoplatform.commons.api.settings.SettingValue

create setting value object of type Double

create(Boolean) - Static method in class org.exoplatform.commons.api.settings.SettingValue

create setting value object of type Boolean

D

DATE_INDEXED - Static variable in class org.exoplatform.commons.api.indexing.IndexingService

delete(SearchEntryId) - Method in class org.exoplatform.commons.api.indexing.IndexingService

Delete entry by id

E

equals(Object) - Method in class org.exoplatform.commons.api.settings.data.SettingContext

equals(Object) - Method in class org.exoplatform.commons.api.settings.data.SettingKey

equals(Object) - Method in class org.exoplatform.commons.api.settings.data.SettingScope

EventListener<S,D> - Interface in org.exoplatform.commons.api.event

This used to process all the dedicated work which be delegated from EventManager To adapt with event manager system then all listeners should be implemented this interface.

EventManager<S,D> - Interface in org.exoplatform.commons.api.event

This is the central point of the event system where listeners are registered (and/or unregistered) and events fired.

EventType - Enum in org.exoplatform.commons.api.settings.data

All possible value type of event

F

File - Interface in org.exoplatform.commons.api.event.data

File object instance.

G

get(Context, Scope, String) - Method in interface org.exoplatform.commons.api.settings.SettingService

get values associated with the composite key (context,scope,key) in the database

getCollection() - Method in class org.exoplatform.commons.api.indexing.data.SearchEntryId

Get collection

getConnectors() - Method in class org.exoplatform.commons.api.search.SearchService

Get all connectors currently

getContent() - Method in class org.exoplatform.commons.api.indexing.data.SearchEntry

Get content

getContext() - Method in class org.exoplatform.commons.api.settings.data.SettingContext

get context object associated to this setting-context

getContextPath() - Method in class org.exoplatform.commons.api.settings.data.SettingContext

get path associated to this setting-context

getCreatedDate() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Return the value of the created date on this Object.

getCreationAuthor() - Method in class org.exoplatform.commons.api.indexing.data.StandardEntry

Get creation author

getCreationDate() - Method in class org.exoplatform.commons.api.indexing.data.StandardEntry

Get creation date

getCurrentRepositoryName() - Static method in class org.exoplatform.commons.api.settings.data.SettingContext

getData() - Method in interface org.exoplatform.commons.api.event.data.File

Return the binary data of File instance

getDate() - Method in class org.exoplatform.commons.api.search.data.SearchResult

Get date of result

getDCContributor() - Method in interface org.exoplatform.commons.api.event.data.File

Return the contributor of File instance.

getDCCreator() - Method in interface org.exoplatform.commons.api.event.data.File

Return the creator of File instance.

getDCDate() - Method in interface org.exoplatform.commons.api.event.data.File

Return the last updated date of File instance.

getDCDescription() - Method in interface org.exoplatform.commons.api.event.data.File

Return the description of File instance.

getDCPublisher() - Method in interface org.exoplatform.commons.api.event.data.File

Return the publisher of File instance.

getDCSubject() - Method in interface org.exoplatform.commons.api.event.data.File

Return the subject of File instance.

getDetail() - Method in class org.exoplatform.commons.api.search.data.SearchResult

Get detail of result

getDisplayName() - Method in class org.exoplatform.commons.api.search.SearchServiceConnector

Get display name

getEncoding() - Method in interface org.exoplatform.commons.api.event.data.File

Return the encoding type of File instance.

getEventListeners(String) - Method in interface org.exoplatform.commons.api.event.EventManager

Return a list of Listener which registered to the event system based on its object type.

getEventType() - Method in class org.exoplatform.commons.api.settings.data.SettingData

get event type associated to this setting data

getExcerpt() - Method in class org.exoplatform.commons.api.indexing.data.SimpleEntry

Get excerpt

getExcerpt() - Method in class org.exoplatform.commons.api.search.data.SearchResult

Get excerpt of result

getId() - Method in class org.exoplatform.commons.api.indexing.data.SearchEntry

Get entry id

getId() - Method in enum org.exoplatform.commons.api.settings.data.Context

Get context id

getId() - Method in enum org.exoplatform.commons.api.settings.data.Scope

getImageUrl() - Method in class org.exoplatform.commons.api.search.data.SearchResult

Get image url of avatar

getKey() - Method in class org.exoplatform.commons.api.settings.data.SettingKey

get key value of setting-key

getLastModified() - Method in interface org.exoplatform.commons.api.event.data.File

Return the last modified date of File instance.

getLastModifiedDate() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Return the value of the last modified date on this Object.

getLastModifier() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Return the name of last person who edited this Object.

getLastUpdateAuthor() - Method in class org.exoplatform.commons.api.indexing.data.StandardEntry

Get last update author

getLastUpdateDate() - Method in class org.exoplatform.commons.api.indexing.data.StandardEntry

Get last update date

getMimeType() - Method in interface org.exoplatform.commons.api.event.data.File

Return the MIMETYPE of File instance.

getMixinTypes() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Return a list of node type name which added to this Object as the mix-in.

getName() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Return the name of Object.

getName() - Method in class org.exoplatform.commons.api.indexing.data.SearchEntryId

Get name

getOwner() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Return the name of who created this Object.

getPath() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

* Returns the absolute path to this item.

getPrimaryType() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Return the primary type of current Object For example: nt:file, exo:webContent,...

getRating() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Return the rate value for this Object

getRelevancy() - Method in class org.exoplatform.commons.api.search.data.SearchResult

Get relevancy of result

getRepositoryName() - Method in class org.exoplatform.commons.api.settings.data.SettingContext

get repository name associated to this setting-context

getRouter() - Method in class org.exoplatform.commons.api.search.data.SearchContext

Get router

getScope() - Method in class org.exoplatform.commons.api.settings.data.SettingScope

get scope value of setting-scope

getScopePath() - Method in class org.exoplatform.commons.api.settings.data.SettingScope

get path associated to this setting-scope

getSearchType() - Method in class org.exoplatform.commons.api.search.SearchServiceConnector

Get search type

getSettingContext() - Method in class org.exoplatform.commons.api.settings.data.SettingData

get setting context associated to this setting data

getSettingValue() - Method in class org.exoplatform.commons.api.settings.data.SettingData

get setting value of setting property associated to this setting data, return null in case of context at level Context and Scope

getSiteName() - Method in class org.exoplatform.commons.api.search.data.SearchContext

Get site name, e.g.

getTags() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Return a list of tags name which added to this Object

getTitle() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Return the title value on this Object.

getTitle() - Method in class org.exoplatform.commons.api.indexing.data.SimpleEntry

Get title

getTitle() - Method in class org.exoplatform.commons.api.search.data.SearchResult

Get title of result

getType() - Method in class org.exoplatform.commons.api.indexing.data.SearchEntryId

Get type

getUrl() - Method in class org.exoplatform.commons.api.indexing.data.SimpleEntry

Get URL

getUrl() - Method in class org.exoplatform.commons.api.search.data.SearchResult

Get url of result

getUUID() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Return the UUID value of this Object.

getValue() - Method in class org.exoplatform.commons.api.settings.SettingValue

Get value object of setting value

getWorkspace() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

Return the workspace name where stored current object.

H

handler(String) - Method in class org.exoplatform.commons.api.search.data.SearchContext

Puts Handler value into QualifiedName map

hashCode() - Method in class org.exoplatform.commons.api.settings.data.SettingContext

hashCode() - Method in class org.exoplatform.commons.api.settings.data.SettingKey

hashCode() - Method in class org.exoplatform.commons.api.settings.data.SettingScope

I

id - Variable in class org.exoplatform.commons.api.indexing.data.SearchEntry

id(String) - Method in enum org.exoplatform.commons.api.settings.data.Context

Create a context with an specify id

id(String) - Method in enum org.exoplatform.commons.api.settings.data.Scope

IndexingService - Class in org.exoplatform.commons.api.indexing

The class provides indexing API that connector implements to index it's data

IndexingService() - Constructor for class org.exoplatform.commons.api.indexing.IndexingService

L

lang(String) - Method in class org.exoplatform.commons.api.search.data.SearchContext

Puts Lang value into QualifiedName map

LAST_UPDATE - Static variable in class org.exoplatform.commons.api.indexing.IndexingService

N

name - Variable in class org.exoplatform.commons.api.indexing.data.SearchEntryId

O

onEvent(Event<SettingService, SettingData>) - Method in class org.exoplatform.commons.api.settings.SettingListener

Callback function when the setting service dispatches an event

onRemoveContext(Event<SettingService, SettingData>) - Method in class org.exoplatform.commons.api.settings.SettingListener

Callback function when all setting properties in a context are removed

onRemoveKey(Event<SettingService, SettingData>) - Method in class org.exoplatform.commons.api.settings.SettingListener

Callback function when a setting property is removed with a specified composite key(context,scope,key)

onRemoveScope(Event<SettingService, SettingData>) - Method in class org.exoplatform.commons.api.settings.SettingListener

Callback function when all setting properties in a scope are removed

onSet(Event<SettingService, SettingData>) - Method in class org.exoplatform.commons.api.settings.SettingListener

Callback function when a new setting property is saved.

org.exoplatform.commons.api.event - package org.exoplatform.commons.api.event

Provides the API for event manager system.

org.exoplatform.commons.api.event.data - package org.exoplatform.commons.api.event.data

Provides the API for data type in event manager system.

org.exoplatform.commons.api.indexing - package org.exoplatform.commons.api.indexing

Provides the class API that other connectors might implement for indexing business.

org.exoplatform.commons.api.indexing.data - package org.exoplatform.commons.api.indexing.data

Provides the classes that defines pattern structures of data entry.

org.exoplatform.commons.api.search - package org.exoplatform.commons.api.search

Provides the class API that other drivers and connectors might implement for searching business.

org.exoplatform.commons.api.search.data - package org.exoplatform.commons.api.search.data

Provides the classes to create search context and search result.

org.exoplatform.commons.api.settings - package org.exoplatform.commons.api.settings

Provides the API for setting service.

org.exoplatform.commons.api.settings.data - package org.exoplatform.commons.api.settings.data

Provides enum type and classes for key specifications in setting service.

P

path(String) - Method in class org.exoplatform.commons.api.search.data.SearchContext

Puts Path value into QualifiedName map

R

remove(Event<S, D>) - Method in interface org.exoplatform.commons.api.event.EventListener

Process the dedicated work when the remove event has been triggered.

remove(Context, Scope, String) - Method in interface org.exoplatform.commons.api.settings.SettingService

remove the SettingValue associated with the specified composite key

remove(Context, Scope) - Method in interface org.exoplatform.commons.api.settings.SettingService

remove all the value associated with the specified context and specified scope in the database.

remove(Context) - Method in interface org.exoplatform.commons.api.settings.SettingService

remove all the value asscociated with the specified context in the database

removeEventListener(Listener<S, D>) - Method in interface org.exoplatform.commons.api.event.EventManager

This will be used to unregister a listener out of the event system.

removeEventListener(String, Listener<S, D>) - Method in interface org.exoplatform.commons.api.event.EventManager

This will be used to unregister a listener out of the event system.

renderLink() - Method in class org.exoplatform.commons.api.search.data.SearchContext

Render link base on router and Map

repositoryName - Variable in class org.exoplatform.commons.api.settings.data.SettingContext

S

save() - Method in interface org.exoplatform.commons.api.event.data.BaseObject

This function used to store all the information to the database.

Scope - Enum in org.exoplatform.commons.api.settings.data

This class allow a user to be able to save some settings linked to a scope.

scope - Variable in class org.exoplatform.commons.api.settings.data.SettingScope

scopePath - Variable in class org.exoplatform.commons.api.settings.data.SettingScope

search(SearchContext, String, Collection<String>, Collection<String>, int, int, String, String) - Method in class org.exoplatform.commons.api.search.SearchService

This search method aggregates search results from all connectors

search(SearchContext, String, Collection<String>, int, int, String, String) - Method in class org.exoplatform.commons.api.search.SearchServiceConnector

The connectors must implement this search method, with the following parameters and return a collection of SearchResult

SearchContext - Class in org.exoplatform.commons.api.search.data

Search Context contains a set of data needed for SearchService and all connectors.

SearchContext(Router, String) - Constructor for class org.exoplatform.commons.api.search.data.SearchContext

Contructor to create a context for search service

SearchContext.RouterParams - Enum in org.exoplatform.commons.api.search.data

SearchEntry - Class in org.exoplatform.commons.api.indexing.data

The class defines data structure of entry that is as input for indexing

SearchEntry() - Constructor for class org.exoplatform.commons.api.indexing.data.SearchEntry

Default constructor

SearchEntry(String, String, String, Map<String, Object>) - Constructor for class org.exoplatform.commons.api.indexing.data.SearchEntry

Constructor creates a entry with specified parameters

SearchEntryId - Class in org.exoplatform.commons.api.indexing.data

The class defines structure of id that specifies a unique entry

SearchEntryId(String, String, String) - Constructor for class org.exoplatform.commons.api.indexing.data.SearchEntryId

Constructor creates entry id

SearchResult - Class in org.exoplatform.commons.api.search.data

Search result returned by SearchService and all of its connectors, for rendering their search results on UI in a unified format.

SearchResult(String, String, String, String, String, long, long) - Constructor for class org.exoplatform.commons.api.search.data.SearchResult

Constructor that helps to create search result by the unique way

SearchService - Class in org.exoplatform.commons.api.search

These class defines the Search API that a driver can implement and provides add/get methods on the connector.

SearchService() - Constructor for class org.exoplatform.commons.api.search.SearchService

SearchServiceConnector - Class in org.exoplatform.commons.api.search

This abstract class is extended by all SearchService connectors, it allow to build from configuration the list of the needed connector for the Unified Search.

SearchServiceConnector(InitParams) - Constructor for class org.exoplatform.commons.api.search.SearchServiceConnector

Constructor is default that other connecters must implement by this way

set(Context, Scope, String, SettingValue<?>) - Method in interface org.exoplatform.commons.api.settings.SettingService

set the specified value with the key which is composed by context, scope, key.

setContent(Map<String, Object>) - Method in class org.exoplatform.commons.api.indexing.data.SearchEntry

Set content

setCreationAuthor(String) - Method in class org.exoplatform.commons.api.indexing.data.StandardEntry

Set creation author

setCreationDate(long) - Method in class org.exoplatform.commons.api.indexing.data.StandardEntry

Set creation Date

setDate(long) - Method in class org.exoplatform.commons.api.search.data.SearchResult

Set data for result

setDetail(String) - Method in class org.exoplatform.commons.api.search.data.SearchResult

Set detail for result

setDisplayName(String) - Method in class org.exoplatform.commons.api.search.SearchServiceConnector

Set display name

setEventType(EventType) - Method in class org.exoplatform.commons.api.settings.data.SettingData

set event type associated to this setting data

setExcerpt(String) - Method in class org.exoplatform.commons.api.indexing.data.SimpleEntry

Set excerpt

setExcerpt(String) - Method in class org.exoplatform.commons.api.search.data.SearchResult

Set excerpt for result

setId(SearchEntryId) - Method in class org.exoplatform.commons.api.indexing.data.SearchEntry

Set entry id

setImageUrl(String) - Method in class org.exoplatform.commons.api.search.data.SearchResult

Set image url for avatar

setKey(String) - Method in class org.exoplatform.commons.api.settings.data.SettingKey

set key value to setting-key

setLastUpdateAuthor(String) - Method in class org.exoplatform.commons.api.indexing.data.StandardEntry

Set last update author

setLastUpdateDate(long) - Method in class org.exoplatform.commons.api.indexing.data.StandardEntry

Set last update date

setRelevancy(long) - Method in class org.exoplatform.commons.api.search.data.SearchResult

Set relevancy

setRouter(Router) - Method in class org.exoplatform.commons.api.search.data.SearchContext

Set router

setSearchType(String) - Method in class org.exoplatform.commons.api.search.SearchServiceConnector

Set search type

setSettingContext(SettingContext) - Method in class org.exoplatform.commons.api.settings.data.SettingData

set setting context associated to this setting data

setSettingValue(SettingValue<?>) - Method in class org.exoplatform.commons.api.settings.data.SettingData

set setting value of setting property (SettingKey) associated to this setting data

SettingContext - Class in org.exoplatform.commons.api.settings.data

SettingContext associates setting properties with a specified context (GLOBAL/USER).

SettingContext(Context) - Constructor for class org.exoplatform.commons.api.settings.data.SettingContext

Create a setting context object with a specified context

SettingData - Class in org.exoplatform.commons.api.settings.data

Class support the setting event management, SettingData contains all information of event to listen.

SettingData(EventType, SettingContext) - Constructor for class org.exoplatform.commons.api.settings.data.SettingData

Create setting data with specified event type and context.

SettingData(EventType, SettingContext, SettingValue<?>) - Constructor for class org.exoplatform.commons.api.settings.data.SettingData

Create setting data with specified event type and setting property

SettingKey - Class in org.exoplatform.commons.api.settings.data

SettingKey is composed by [context,scope,key], associates with a specified setting property value.

SettingKey(Context, Scope, String) - Constructor for class org.exoplatform.commons.api.settings.data.SettingKey

Create setting key with composite key [context,scope,key]

SettingListener - Class in org.exoplatform.commons.api.settings

For each call of the SettingService API, it will trigger the event corresponding

SettingListener() - Constructor for class org.exoplatform.commons.api.settings.SettingListener

SettingScope - Class in org.exoplatform.commons.api.settings.data

SettingScope is composed by [context,scope], associates with setting properties in a specified scope.

SettingScope(Context, Scope) - Constructor for class org.exoplatform.commons.api.settings.data.SettingScope

Create setting scope object with composite key [context,scope]

SettingService - Interface in org.exoplatform.commons.api.settings

This Service allow to store and remove a value associated with a key in JCR

SettingValue<T> - Class in org.exoplatform.commons.api.settings

All possible value type stored in JCR

SettingValue(T) - Constructor for class org.exoplatform.commons.api.settings.SettingValue

Create a setting value object with a specify value type

setTitle(String) - Method in class org.exoplatform.commons.api.indexing.data.SimpleEntry

Set title

setTitle(String) - Method in class org.exoplatform.commons.api.search.data.SearchResult

Set title for result

setUrl(String) - Method in class org.exoplatform.commons.api.indexing.data.SimpleEntry

Set URL

setUrl(String) - Method in class org.exoplatform.commons.api.search.data.SearchResult

Set url for result

SimpleEntry - Class in org.exoplatform.commons.api.indexing.data

The class defines a simple entry

SimpleEntry() - Constructor for class org.exoplatform.commons.api.indexing.data.SimpleEntry

siteName(String) - Method in class org.exoplatform.commons.api.search.data.SearchContext

Puts SiteType value into QualifiedName map

siteType(String) - Method in class org.exoplatform.commons.api.search.data.SearchContext

Puts SiteType value into QualifiedName map

StandardEntry - Class in org.exoplatform.commons.api.indexing.data

The class defines standard entry

StandardEntry() - Constructor for class org.exoplatform.commons.api.indexing.data.StandardEntry

T

Tools - Class in org.exoplatform.commons.api.settings.data

This class is useful to build the path of object saved in Jcr.

Tools() - Constructor for class org.exoplatform.commons.api.settings.data.Tools

toString() - Method in class org.exoplatform.commons.api.indexing.data.SearchEntry

toString() - Method in class org.exoplatform.commons.api.indexing.data.SearchEntryId

toString() - Method in class org.exoplatform.commons.api.search.data.SearchResult

type - Variable in class org.exoplatform.commons.api.indexing.data.SearchEntryId

U

update(Event<S, D>) - Method in interface org.exoplatform.commons.api.event.EventListener

Process the dedicated work when the update event has been triggered.

update(SearchEntryId, Map<String, Object>) - Method in class org.exoplatform.commons.api.indexing.IndexingService

Update entry

V

valueOf(String) - Static method in enum org.exoplatform.commons.api.search.data.SearchContext.RouterParams

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.exoplatform.commons.api.settings.data.Context

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.exoplatform.commons.api.settings.data.EventType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.exoplatform.commons.api.settings.data.Scope

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.exoplatform.commons.api.search.data.SearchContext.RouterParams

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.exoplatform.commons.api.settings.data.Context

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.exoplatform.commons.api.settings.data.EventType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.exoplatform.commons.api.settings.data.Scope

Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I L N O P R S T U V