com.endeca.portal.data

Class MDEXState

java.lang.Object

com.endeca.portal.data.MDEXState

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class MDEXState
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Portlet developers should avoid this class. See DataSource instead. Note that with the exception of #getQueryState() and setQueryState(QueryState) this class is not thread safe. All other getters and setters provided by this class are not synchronized.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CURRENTFUNCTIONS_PROPERTY
static java.lang.String	DESCRIPTION_PROPERTY
static java.lang.String	ID_PROPERTY
protected java.util.List<IncompleteCollectionState>	incompleteCollections
protected QueryState	initialState
static java.lang.String	NAME_PROPERTY
static java.lang.String	RESTRICTED_TO_ROLES_PROPERTY
static java.lang.String	RESTRICTED_TO_USERS_PROPERTY
protected java.util.List<java.lang.String>	restrictedToRoles
protected java.util.List<java.lang.String>	restrictedToUsers
protected QueryState	state
protected java.lang.String	statusMessage
static java.lang.String	VIEWMETADATA_PROPERTY

Constructor Summary

Constructors

Constructor and Description
MDEXState(long groupId, javax.portlet.PortletRequest request)
MDEXState(java.lang.String[] boundDatasets, javax.portlet.PortletRequest request)

Method Summary

Methods

Modifier and Type	Method and Description
MDEXState	clone()
java.lang.String[]	getBoundDataSets()
protected ViewCache<CollectionBaseView>	getCollectionCache() Intended to be called only by CollectionManager, which synchronizes CRUD operations on the collection cache.
java.util.List<IncompleteCollectionState>	getIncompleteCollections()
QueryState	getInitialQueryState(javax.portlet.PortletRequest request) Returns the initial QueryState associated with this MDEXState, including any valid base functions present in the MDEXState's configuration.
java.util.Date	getLastPinged()
QueryState	getQueryState(javax.portlet.PortletRequest request)
long	getQueryStateVersion()
java.util.List<java.lang.String>	getRestrictedToRoles()
java.util.List<java.lang.String>	getRestrictedToUsers()
java.lang.String	getStatusMessage()
protected ViewCache<SemanticView>	getViewCache() Fetches the view cache.
java.util.List<ViewMetadata>	getViewMetaDataList()
boolean	isAvailable() Checks whether the index represented by this MDEXState is currently available.
boolean	isAvailableByUserID(long userId)
boolean	isOnline() Returns the cached availability of this index.
boolean	needsRefreshBasedOnProjectInventoryVersion(long projectInventoryVersion)
void	resetQueryStateWithBaseFilter(javax.portlet.PortletRequest request)
void	setIncompleteCollections(java.util.List<IncompleteCollectionState> incompleteCollections)
void	setLastPinged(java.util.Date lastPinged)
void	setQueryState(QueryState dss) Deprecated.
void	setStatusMessage(java.lang.String statusMessage)
protected void	setupLinkedDatasetFilters(QueryState queryState, javax.portlet.PortletRequest request) If necessary, adds a PrimaryDatasetJoinFilterset to achieve data set linked filtering configured for the current page.
void	setViewMetaDataList(java.util.List<ViewMetadata> viewMetaData)
boolean	updateStatus() Updates the status of this MDEXState.
boolean	validateGroupId(long groupId)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

state

protected QueryState state

initialState

protected QueryState initialState

statusMessage

protected java.lang.String statusMessage

incompleteCollections

protected java.util.List<IncompleteCollectionState> incompleteCollections

restrictedToUsers

protected java.util.List<java.lang.String> restrictedToUsers

restrictedToRoles

protected java.util.List<java.lang.String> restrictedToRoles

NAME_PROPERTY

public static final java.lang.String NAME_PROPERTY

See Also:

Constant Field Values

DESCRIPTION_PROPERTY

public static final java.lang.String DESCRIPTION_PROPERTY

See Also:

Constant Field Values

VIEWMETADATA_PROPERTY

public static final java.lang.String VIEWMETADATA_PROPERTY

See Also:

Constant Field Values

ID_PROPERTY

public static final java.lang.String ID_PROPERTY

See Also:

Constant Field Values

CURRENTFUNCTIONS_PROPERTY

public static final java.lang.String CURRENTFUNCTIONS_PROPERTY

See Also:

Constant Field Values

RESTRICTED_TO_USERS_PROPERTY

public static final java.lang.String RESTRICTED_TO_USERS_PROPERTY

See Also:

Constant Field Values

RESTRICTED_TO_ROLES_PROPERTY

public static final java.lang.String RESTRICTED_TO_ROLES_PROPERTY

See Also:

Constant Field Values

Constructor Detail

MDEXState

public MDEXState(java.lang.String[] boundDatasets,
         javax.portlet.PortletRequest request)

MDEXState

public MDEXState(long groupId,
         javax.portlet.PortletRequest request)

Method Detail

isAvailable

public boolean isAvailable()

Checks whether the index represented by this MDEXState is currently available. Note that this method uses caching for positive/OK status, and if the status was previously unavailable, calls to isAvailable() will force a status check. To check that status without a status refresh, use isOnline().

Returns:

true if the server/data-domain is available after this call.

See Also:

isOnline(), updateStatus()

isOnline

public boolean isOnline()

Returns the cached availability of this index. This call relied on the previously established availability status, and will not re-test or update the status. If status refresh is desired, use the isAvailable() method.

Returns:

true if the data domain was available at last check

See Also:

isAvailable()

getStatusMessage

public java.lang.String getStatusMessage()

setStatusMessage

public void setStatusMessage(java.lang.String statusMessage)

getRestrictedToUsers

public java.util.List<java.lang.String> getRestrictedToUsers()

getRestrictedToRoles

public java.util.List<java.lang.String> getRestrictedToRoles()

setIncompleteCollections

public void setIncompleteCollections(java.util.List<IncompleteCollectionState> incompleteCollections)

getIncompleteCollections

public java.util.List<IncompleteCollectionState> getIncompleteCollections()

isAvailableByUserID

public boolean isAvailableByUserID(long userId)

Returns:

true if this data source supports is available to the user

setupLinkedDatasetFilters

protected void setupLinkedDatasetFilters(QueryState queryState,
                             javax.portlet.PortletRequest request)

If necessary, adds a PrimaryDatasetJoinFilterset to achieve data set linked filtering configured for the current page. If such a filter is already present in the QueryState, nothing more is done.

getQueryState

public QueryState getQueryState(javax.portlet.PortletRequest request)

Parameters:

request -

Returns:

a copy of the QueryState object which have base filter applied automatically

setQueryState

@Deprecated
public void setQueryState(QueryState dss)

Deprecated.

Set the QueryState. In general, this should *ONLY* be called from the DataSource facade, but may need to be accessible for things like reloading bookmarks from a stored state, etc. This method isn't really deprecated... the flag is used to force compile time warnings. TODO: This needs to be undeprecated and made protected. Because the Bookmarks Portlet legitimately needs this functionality, a wrapper for this method should probably be exposed by the DataSource

Parameters:

dss -

resetQueryStateWithBaseFilter

public void resetQueryStateWithBaseFilter(javax.portlet.PortletRequest request)

getInitialQueryState

public QueryState getInitialQueryState(javax.portlet.PortletRequest request)

Returns the initial QueryState associated with this MDEXState, including any valid base functions present in the MDEXState's configuration.

Returns:

initial QueryState

getViewCache

protected ViewCache<SemanticView> getViewCache()

Fetches the view cache. Intended to be called only by SemanticViewManager, which synchronizes CRUD operations on the view cache.

Returns:

the view cache

getCollectionCache

protected ViewCache<CollectionBaseView> getCollectionCache()

Intended to be called only by CollectionManager, which synchronizes CRUD operations on the collection cache.

Returns:

the collection cache

setViewMetaDataList

public void setViewMetaDataList(java.util.List<ViewMetadata> viewMetaData)

getViewMetaDataList

public java.util.List<ViewMetadata> getViewMetaDataList()

clone

public MDEXState clone()

Overrides:

clone in class java.lang.Object

updateStatus

public boolean updateStatus()

Updates the status of this MDEXState. Only the DataSourceConfigHelper has the global reference for MDEXStates. All other utilities get a clone. Obviously, updating the clone won't update the global reference.

getQueryStateVersion

public long getQueryStateVersion()

getLastPinged

public java.util.Date getLastPinged()

setLastPinged

public void setLastPinged(java.util.Date lastPinged)

getBoundDataSets

public java.lang.String[] getBoundDataSets()

validateGroupId

public boolean validateGroupId(long groupId)

needsRefreshBasedOnProjectInventoryVersion

public boolean needsRefreshBasedOnProjectInventoryVersion(long projectInventoryVersion)