|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.portal.data.MDEXState
public class MDEXState
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.
Nested Class Summary | |
---|---|
static class |
MDEXState.APIVersion
|
static class |
MDEXState.MDEXRecords
|
Field Summary | |
---|---|
static java.lang.String |
API_VERSION_PROPERTY
|
static java.lang.String |
BASEFUNCTIONS_PROPERTY
|
static java.lang.String |
BASEQUERYOPTIONS_PROPERTY
|
static java.lang.String |
CURRENTFUNCTIONS_PROPERTY
|
protected java.lang.String |
datastoreName
|
static java.lang.String |
DB_PROPERTY
|
static MDEXState.APIVersion |
DEFAULT_API_VERSION
|
static com.endeca.portal.data.MDEXState.EngineVersion |
DEFAULT_ENGINE_VERSION
|
static MDEXState.MDEXRecords |
DEFAULT_MDEX_RECORDS
|
static java.lang.String |
DESCRIPTION_PROPERTY
|
com.endeca.portal.data.MDEXState.EngineVersion |
engineVersion
|
protected java.lang.String |
id
|
static java.lang.String |
ID_PROPERTY
|
protected QueryState |
initialState
|
static java.lang.String |
MDEX_RECORDS_PROPERTY
|
protected java.lang.String |
name
|
static java.lang.String |
NAME_PROPERTY
|
static java.lang.String |
PORT_PROPERTY
|
static java.lang.String |
SERVER_PROPERTY
|
static java.lang.String |
SSL_CONFIG_PROPERTY
|
protected QueryState |
state
|
protected java.lang.String |
statusMessage
|
static java.lang.String |
UPDATE_PORT_PROPERTY
|
static java.lang.String |
UPDATE_SERVER_PROPERTY
|
static java.lang.String |
UPDATE_SSL_CONFIG_PROPERTY
|
Constructor Summary | |
---|---|
MDEXState(org.json.JSONObject configuration)
|
Method Summary | |
---|---|
void |
clearEntityCaches()
Clear the entities and predefined metrics caches. |
MDEXState |
clone()
|
MDEXAttributeList |
getAttributes()
|
AttributeSettings |
getAttributeSettings()
|
com.endeca.mdex.config.services.config._2010.ConfigPort |
getConfigServicePort()
Convenience method for getting the Config service port |
java.lang.String |
getConfigServiceURL()
This method is only useful when the data source supports the discovery service. |
java.lang.String |
getDataSourceNotUpdatableMessage()
|
java.lang.String |
getDatastoreName()
|
java.lang.String |
getDescription()
|
com.endeca.mdex.conversation.ConversationPort |
getDiscoveryServicePort(boolean useMaster)
Convenience method for getting the Conversation service port |
java.lang.String |
getDiscoveryServiceURL(boolean useMaster)
|
java.util.List<com.endeca.mdex.sconfig._2010.types.SemanticEntity> |
getEntitiesCache(boolean cacheEnabled)
|
long |
getEntryVersion()
|
javax.xml.namespace.QName |
getEventName()
|
java.lang.String |
getId()
|
org.json.JSONObject |
getInitialConfiguration()
|
QueryState |
getInitialQueryState()
Returns the initial QueryState associated with this MDEXState , including
any valid base functions present in the MDEXState's configuration. |
boolean |
getIsSSLEnabled()
|
com.endeca.mdex.lql_parser._2010.ParserPort |
getLQLParserPort()
Convenience method for getting the LQL Parser service port |
java.lang.String |
getLQLParserServiceURL()
|
MDEXState.MDEXRecords |
getMdexRecords()
|
java.lang.String |
getName()
|
java.lang.String |
getPort()
|
java.util.List<com.endeca.mdex.lql_parser._2010.ParsedMetric> |
getPredefinedMetricsCache(java.lang.String entity,
boolean cacheEnabled)
|
QueryState |
getQueryState()
|
com.endeca.mdex.sconfig._2010.SConfigPort |
getSConfigPort(boolean canUpdate)
Convenience method for getting the Semantic Config service port |
java.lang.String |
getSConfigServiceURL(boolean canUpdate)
|
java.lang.String |
getServer()
|
SSLConfig |
getSSLConfig()
|
java.lang.String |
getStatusMessage()
|
java.lang.String |
getUpdatePort()
|
java.lang.String |
getUpdateServer()
|
SSLConfig |
getUpdateSSLConfig()
|
MDEXState.APIVersion |
getVersion()
|
boolean |
isAvailable()
|
boolean |
isUpdatable()
|
boolean |
isUpdateSSLEnabled()
|
boolean |
isValid()
|
protected void |
setAttributes(MDEXAttributeList mdexAttributes)
|
protected void |
setAttributeSettings(AttributeSettings attributeSettings)
This should only ever be used by the DataSource to store AttributeSettings for the purposes of caching. |
void |
setEntitiesCache(java.util.List<com.endeca.mdex.sconfig._2010.types.SemanticEntity> entitiesCache,
boolean cacheEnabled)
|
void |
setEntryVersion(long entryVersion)
|
void |
setPredefinedMetricsCache(java.lang.String entity,
java.util.List<com.endeca.mdex.lql_parser._2010.ParsedMetric> predefinedMetrics,
boolean cacheEnabled)
|
void |
setQueryState(QueryState dss)
Deprecated. |
boolean |
supportsConfigService()
|
boolean |
supportsDiscoveryService()
|
boolean |
supportsFeature(Feature f)
|
boolean |
supportsLQLParserService()
|
boolean |
supportsSConfigService()
|
org.json.JSONObject |
toJSON()
|
java.lang.String |
toString()
|
boolean |
updateStatus()
Updates the status of this MDEXState. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected java.lang.String id
protected java.lang.String name
protected java.lang.String datastoreName
public com.endeca.portal.data.MDEXState.EngineVersion engineVersion
protected QueryState state
protected QueryState initialState
protected java.lang.String statusMessage
public static final java.lang.String SERVER_PROPERTY
public static final java.lang.String PORT_PROPERTY
public static final java.lang.String UPDATE_SERVER_PROPERTY
public static final java.lang.String UPDATE_PORT_PROPERTY
public static final java.lang.String UPDATE_SSL_CONFIG_PROPERTY
public static final java.lang.String SSL_CONFIG_PROPERTY
public static final java.lang.String NAME_PROPERTY
public static final java.lang.String DESCRIPTION_PROPERTY
public static final java.lang.String ID_PROPERTY
public static final java.lang.String DB_PROPERTY
public static final java.lang.String BASEQUERYOPTIONS_PROPERTY
public static final java.lang.String BASEFUNCTIONS_PROPERTY
public static final java.lang.String CURRENTFUNCTIONS_PROPERTY
public static final java.lang.String API_VERSION_PROPERTY
public static final java.lang.String MDEX_RECORDS_PROPERTY
public static final MDEXState.APIVersion DEFAULT_API_VERSION
public static final com.endeca.portal.data.MDEXState.EngineVersion DEFAULT_ENGINE_VERSION
public static final MDEXState.MDEXRecords DEFAULT_MDEX_RECORDS
Constructor Detail |
---|
public MDEXState(org.json.JSONObject configuration) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
Method Detail |
---|
public long getEntryVersion()
public java.lang.String getId()
public java.lang.String getName()
public java.lang.String getDatastoreName()
public java.lang.String getServer()
public java.lang.String getPort()
public java.lang.String getUpdatePort()
public java.lang.String getUpdateServer()
public MDEXState.APIVersion getVersion()
public boolean supportsDiscoveryService()
public boolean supportsConfigService()
public boolean supportsSConfigService()
public boolean supportsLQLParserService()
public boolean supportsFeature(Feature f)
public MDEXState.MDEXRecords getMdexRecords()
public SSLConfig getUpdateSSLConfig()
public boolean isUpdateSSLEnabled()
public SSLConfig getSSLConfig()
public boolean getIsSSLEnabled()
public boolean isAvailable()
public boolean isUpdatable()
public boolean isValid()
public java.lang.String getDescription()
public java.lang.String getStatusMessage()
public javax.xml.namespace.QName getEventName()
public org.json.JSONObject getInitialConfiguration()
public void setEntryVersion(long entryVersion)
public QueryState getQueryState()
@Deprecated public void setQueryState(QueryState dss)
DataSource
dss
- public QueryState getInitialQueryState()
QueryState
associated with this MDEXState
, including
any valid base functions present in the MDEXState's configuration.
protected void setAttributes(MDEXAttributeList mdexAttributes)
public MDEXAttributeList getAttributes()
protected void setAttributeSettings(AttributeSettings attributeSettings)
attributeSettings
- the attributeSettings to setpublic AttributeSettings getAttributeSettings()
public java.util.List<com.endeca.mdex.sconfig._2010.types.SemanticEntity> getEntitiesCache(boolean cacheEnabled)
public void setEntitiesCache(java.util.List<com.endeca.mdex.sconfig._2010.types.SemanticEntity> entitiesCache, boolean cacheEnabled)
entitiesCache
- the entities to be cached for retrieval by calls to getEntitiesCache.public java.util.List<com.endeca.mdex.lql_parser._2010.ParsedMetric> getPredefinedMetricsCache(java.lang.String entity, boolean cacheEnabled)
public void setPredefinedMetricsCache(java.lang.String entity, java.util.List<com.endeca.mdex.lql_parser._2010.ParsedMetric> predefinedMetrics, boolean cacheEnabled)
entity
- the key of the entity whose metrics are being cachedpredefinedMetrics
- the metrics to cachecacheEnabled
- whether or not to cache metricspublic void clearEntityCaches()
public java.lang.String getDiscoveryServiceURL(boolean useMaster)
public java.lang.String getConfigServiceURL() throws java.lang.UnsupportedOperationException
java.lang.UnsupportedOperationException
public java.lang.String getSConfigServiceURL(boolean canUpdate)
public java.lang.String getLQLParserServiceURL()
public com.endeca.mdex.conversation.ConversationPort getDiscoveryServicePort(boolean useMaster)
public com.endeca.mdex.config.services.config._2010.ConfigPort getConfigServicePort() throws java.lang.UnsupportedOperationException
java.lang.UnsupportedOperationException
public com.endeca.mdex.sconfig._2010.SConfigPort getSConfigPort(boolean canUpdate) throws DataSourceException
DataSourceException
public com.endeca.mdex.lql_parser._2010.ParserPort getLQLParserPort() throws DataSourceException
DataSourceException
public java.lang.String toString()
toString
in class java.lang.Object
public org.json.JSONObject toJSON() throws org.json.JSONException
org.json.JSONException
public MDEXState clone()
clone
in class java.lang.Object
public boolean updateStatus()
public java.lang.String getDataSourceNotUpdatableMessage()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |