|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.endeca.portal.data.SemanticViewManager
public class SemanticViewManager
Nested Class Summary | |
---|---|
static class |
SemanticViewManager.GroupAllFilter
Nested class implementation of a filter that removes group named 'all' |
Field Summary | |
---|---|
static java.lang.String |
AVAIL_DATETIME_PARTS
|
static java.lang.String |
AVAILABLE_AGGRAGATIONS_DELIMITER
|
static java.lang.String |
DEFAULT_AGG_ORD
|
static java.lang.String |
DEFAULT_AVAIL_AGG_BOOL
|
static java.lang.String |
DEFAULT_AVAIL_AGG_DATETIME
|
static java.lang.String |
DEFAULT_AVAIL_AGG_DURATION
|
static java.lang.String |
DEFAULT_AVAIL_AGG_GEO
|
static java.lang.String |
DEFAULT_AVAIL_AGG_NUM
|
static java.lang.String |
DEFAULT_AVAIL_AGG_SET
|
static java.lang.String |
DEFAULT_AVAIL_AGG_STRING
|
static java.lang.String |
DEFAULT_AVAIL_AGG_TIME
|
static java.lang.String |
DEFAULT_AVAIL_DATETIME_PARTS
|
static java.lang.String |
EID_PROPERTY_PREFIX
|
static java.lang.String |
GROUP_PROPERTY_PREFIX
|
static java.lang.String |
INCL_DETAILS_PROPERTY_DEFAULT_VALUE
|
static java.lang.String |
INCL_NAV_PROPERTY_DEFAULT_VALUE
|
static java.lang.String |
MDEX_TYPE_SET_SUFFIX
|
static java.lang.String |
SYSTEM_AVAILABLE_AGGREGATIONS
|
static java.lang.String |
SYSTEM_DATETIME_COMBOS_ENABLED_PROPERTY
|
static java.lang.String |
SYSTEM_DATETIME_FINEST_LEVEL_PROPERTY
|
static java.lang.String |
SYSTEM_DEFAULT_AGGREGATION
|
static java.lang.String |
SYSTEM_DESCRIPTION
|
static java.lang.String |
SYSTEM_FORMAT_SETTINGS
|
static java.lang.String |
SYSTEM_IS_DIMENSION
|
static java.lang.String |
SYSTEM_IS_SINGLE_ASSIGN
|
static java.lang.String |
SYSTEM_LOCALIZED_ATTRIBUTE_METADATA
|
static java.lang.String |
SYSTEM_LOCALIZED_DESC_SETTINGS
|
static java.lang.String |
SYSTEM_LOCALIZED_DN_SETTINGS
|
Constructor Summary | |
---|---|
SemanticViewManager()
|
Method Summary | |
---|---|
protected static void |
clearViewCaches(MDEXState state)
Clears the view cache, causing subsequent reads to reload the cache from Endeca Server. |
static SemanticView |
createEmptySemanticView(java.lang.String key)
Convenience method that creates a new empty instance of the SemanticView model. |
static SemanticView |
createEmptySemanticView(java.lang.String key,
int attrSize,
int groupSize)
Convenience method that creates a new empty instance of the SemanticView model with predefined collection sizes. |
protected static com.endeca.mdex.sconfig._2010.types.DeleteEntitiesResponse |
deleteView(SemanticView sView,
MDEXState state,
RequestIds requestIds,
java.util.Locale locale)
Deletes one or more views from the Endeca Server. |
static SemanticView |
deserializeSemanticView(java.lang.String semanticViewJson)
Deserializes an attribute settings model using Jackson. |
static SemanticView |
filter(SemanticView semanticView,
BPCFilter groupFilter,
BPCFilter attributeFilter,
boolean removeUngroupedAttributes)
This method allows an SemanticView model object to be filtered in accordance with the specified filters. |
protected static java.lang.String |
getDefaultAvailAggregation(java.lang.String datatype,
boolean isSingleAssign)
Get default enabled available aggregation methods by datatype. |
static java.lang.String |
getLocalized(java.util.Locale locale,
java.lang.String localizedStr,
java.lang.String defaultStr)
Get localized string. |
static java.lang.String |
getLocalizedDescription(com.endeca.mdex.sconfig._2010.types.SemanticAttribute attribute,
java.util.Locale locale)
Get localized description from semantic attribute |
static java.lang.String |
getLocalizedDisplayName(com.endeca.mdex.sconfig._2010.types.SemanticAttribute attribute,
java.util.Locale locale)
Get localized display name from semantic attribute |
protected static java.util.Map<java.lang.String,SemanticView> |
getOrLoadViewCache(MDEXState state,
RequestIds requestIds,
java.util.Locale locale)
Retrieves view cache from MDEXState or (re-)builds this cache if
it has been cleared. |
static SemanticView |
mergeTwoPartials(DataSource datasource,
java.lang.String semanticKey,
SemanticView base,
SemanticView changes,
java.util.Locale locale)
This method merges two attribute sets with each other, and adds filters for the datasource's global groups and attributes. |
static SemanticView |
mergeTwoPartials(SemanticView base,
SemanticView changes,
BPCFilter groupFilter,
BPCFilter attributeFilter,
boolean allowCleanup,
boolean doUnion)
Merges two attribute settings model structures. |
static SemanticView |
mergeWithGlobal(DataSource datasource,
java.lang.String semanticKey,
SemanticView changes)
This method merges the submitted changes with the global attribute settings associated with the datasource. |
static SemanticView |
mergeWithGlobal(DataSource datasource,
java.lang.String semanticKey,
SemanticView changes,
BPCFilter groupFilter,
BPCFilter attributeFilter,
boolean doUnion)
Does a join between the global model associated with the datasource, and the given attribute settings object. |
static SemanticView |
mergeWithGlobal(DataSource datasource,
java.lang.String semanticKey,
SemanticView changes,
BPCFilter groupFilter,
BPCFilter attributeFilter,
boolean doUnion,
java.util.Locale locale)
Does a join between the global model associated with the datasource, and the given attribute settings object. |
static SemanticView |
mergeWithGlobal(DataSource datasource,
java.lang.String semanticKey,
SemanticView changes,
java.util.Locale locale)
This method merges the submitted changes with the global attribute settings associated with the datasource. |
protected static com.endeca.mdex.sconfig._2010.types.PutEntityResponse |
putView(SemanticView sView,
MDEXState state,
RequestIds requestIds,
java.util.Locale locale)
Adds or replaces an entity definitions in the Endeca Server. |
static java.lang.String |
serializeSemanticView(SemanticView semanticView)
Serialize a given SemanticView object into a JSON model |
static java.lang.String |
serializeSemanticViewPrettyPrint(SemanticView semanticView)
Same as serializeSemanticView(SemanticView) except it uses
pretty-print format for output. |
protected static com.endeca.mdex.sconfig._2010.types.ValidateEntityResponse |
validateView(SemanticView sView,
MDEXState state,
RequestIds requestIds,
java.util.Locale locale)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String EID_PROPERTY_PREFIX
public static final java.lang.String GROUP_PROPERTY_PREFIX
public static final java.lang.String SYSTEM_DATETIME_FINEST_LEVEL_PROPERTY
public static final java.lang.String SYSTEM_DATETIME_COMBOS_ENABLED_PROPERTY
public static final java.lang.String SYSTEM_AVAILABLE_AGGREGATIONS
public static final java.lang.String SYSTEM_DEFAULT_AGGREGATION
public static final java.lang.String SYSTEM_DESCRIPTION
public static final java.lang.String SYSTEM_LOCALIZED_DN_SETTINGS
public static final java.lang.String SYSTEM_LOCALIZED_DESC_SETTINGS
public static final java.lang.String SYSTEM_FORMAT_SETTINGS
public static final java.lang.String SYSTEM_IS_DIMENSION
public static final java.lang.String SYSTEM_LOCALIZED_ATTRIBUTE_METADATA
public static final java.lang.String SYSTEM_IS_SINGLE_ASSIGN
public static final java.lang.String AVAILABLE_AGGRAGATIONS_DELIMITER
public static final java.lang.String DEFAULT_AGG_ORD
public static final java.lang.String DEFAULT_AVAIL_AGG_NUM
public static final java.lang.String DEFAULT_AVAIL_AGG_STRING
public static final java.lang.String DEFAULT_AVAIL_AGG_DATETIME
public static final java.lang.String DEFAULT_AVAIL_AGG_TIME
public static final java.lang.String DEFAULT_AVAIL_AGG_DURATION
public static final java.lang.String DEFAULT_AVAIL_AGG_GEO
public static final java.lang.String DEFAULT_AVAIL_AGG_SET
public static final java.lang.String DEFAULT_AVAIL_AGG_BOOL
public static final java.lang.String AVAIL_DATETIME_PARTS
public static final java.lang.String DEFAULT_AVAIL_DATETIME_PARTS
public static final java.lang.String INCL_NAV_PROPERTY_DEFAULT_VALUE
public static final java.lang.String INCL_DETAILS_PROPERTY_DEFAULT_VALUE
public static final java.lang.String MDEX_TYPE_SET_SUFFIX
Constructor Detail |
---|
public SemanticViewManager()
Method Detail |
---|
public static SemanticView deserializeSemanticView(java.lang.String semanticViewJson) throws org.codehaus.jackson.JsonParseException, org.codehaus.jackson.map.JsonMappingException, java.io.IOException
semanticViewJson
- - a serialized JSON representation of the SemanticView model.
org.codehaus.jackson.JsonParseException
org.codehaus.jackson.map.JsonMappingException
java.io.IOException
public static java.lang.String serializeSemanticView(SemanticView semanticView) throws org.codehaus.jackson.JsonGenerationException, org.codehaus.jackson.map.JsonMappingException, java.io.IOException
semanticView
-
org.codehaus.jackson.JsonGenerationException
org.codehaus.jackson.map.JsonMappingException
java.io.IOException
public static java.lang.String serializeSemanticViewPrettyPrint(SemanticView semanticView) throws org.codehaus.jackson.JsonGenerationException, org.codehaus.jackson.map.JsonMappingException, java.io.IOException
serializeSemanticView(SemanticView)
except it uses
pretty-print format for output.
NOTE: Do not use this except for debug/test as it is somewhat slower than serializeSemanticView
semanticView
-
org.codehaus.jackson.JsonGenerationException
org.codehaus.jackson.map.JsonMappingException
java.io.IOException
public static SemanticView mergeWithGlobal(DataSource datasource, java.lang.String semanticKey, SemanticView changes) throws DataSourceException, KeyNotFoundException
datasource
- semanticKey
- changes
-
DataSourceException
KeyNotFoundException
public static SemanticView mergeWithGlobal(DataSource datasource, java.lang.String semanticKey, SemanticView changes, java.util.Locale locale) throws DataSourceException, KeyNotFoundException
datasource
- semanticKey
- changes
- locale
-
DataSourceException
KeyNotFoundException
public static SemanticView mergeWithGlobal(DataSource datasource, java.lang.String semanticKey, SemanticView changes, BPCFilter groupFilter, BPCFilter attributeFilter, boolean doUnion, java.util.Locale locale) throws DataSourceException, KeyNotFoundException
datasource
- - the left hand side of the merge operation is the global attribute settings object associated
with this datasource. Required.semanticKey
- - the semantic view key. Required.changes
- - the right hand side of the merge operation. This should be an instance of an attribute
settings model that contains changes that should be applied to the global attribute settings. Required.groupFilter
- - optional BPC Filter object that is used to filter the groups in the final
result of the merge operation before it is returned. If this parameter is set to null,
no filtering occurs. Otherwise, only the groups that pass the filter test will be included
in the results. This filter will also be applied to the groupOrder list. However, this filter
will NOT prevent ungrouped attributes from appearing in the result.attributeFilter
- - a BPC Filter object that is used to filter the attributes portion of the
merge operation before it is returned. If this parameter is set to null, no filtering occurs.
Otherwise, only the attributes that pass the filter test will be included in the results.doUnion
- - when true, this merge will be a union of the two maps with some special handling surrounding
null values. If this parameter is false, this merge will be a left join, with global attributes on
the left side of the join (objects only appearing on the right hand side will not be included in
the results).locale
- - Localized group/attribute/metric display name and view display name, description
DataSourceException
KeyNotFoundException
public static SemanticView mergeWithGlobal(DataSource datasource, java.lang.String semanticKey, SemanticView changes, BPCFilter groupFilter, BPCFilter attributeFilter, boolean doUnion) throws DataSourceException, KeyNotFoundException
datasource
- semanticKey
- changes
- groupFilter
- attributeFilter
- doUnion
-
DataSourceException
KeyNotFoundException
public static SemanticView mergeTwoPartials(DataSource datasource, java.lang.String semanticKey, SemanticView base, SemanticView changes, java.util.Locale locale) throws DataSourceException, KeyNotFoundException
SemanticViewManager#mergeTwoPartials(SemanticView base, SemanticView changes, datasource.getGlobalAttributeSettings().getGroupFilter(),
datasource.getGlobalAttributeSettings().getAttributeFilter(), true, true)
base
- changes
-
DataSourceException
KeyNotFoundException
public static SemanticView mergeTwoPartials(SemanticView base, SemanticView changes, BPCFilter groupFilter, BPCFilter attributeFilter, boolean allowCleanup, boolean doUnion)
SemanticViewManager#mergeWithGlobal(DataSource, SemanticView)
is recommended.
This method also takes additional parameters that define whether or not empty value cleanup is allowed,
whether to do a union style merge or a left join, and whether the Attribute Groups should be filtered.
base
- - the Left-Hand Side of the merge operation. This should be an instance of an attribute
settings model, to which the changes should be applied. Required.changes
- - the Right-Hand Side of the merge operation. This should be an instance of an attribute
settings model that contains changes that should be applied to the "base". Required.groupFilter
- - a BPC Filter object that is used to filter the final result of the merge
operation before it is returned. This parameter provides a filtering mechanism that allows
the resulting SemanticView model to only contain information limited to the specified
groups. If this parameter is set to null, no filtering occurs. Otherwise, only the
groups that pass the filter test will be included in the results. This filter will also be
applied to the groupOrder list. However, this filter will NOT prevent ungrouped attributes
from appearing in the result.attributeFilter
- - a BPC Filter object that is used to filter the attributes portion of the
merge operation before it is returned. If this parameter is set to null, no filtering
occurs.
Otherwise, only the attributes that pass the filter test will be included in the results.allowCleanup
- - when true allows individual properties or whole attributes/groups to be removed
from the result of the merge. Generally, this should be set to true when merging to partial
models and false when merging a global model with the partial diff. The removal works as
follows. If a property is specified in the changes but its value is set to null, that
property is removed from the merged attribute/group. If an attribute/group key is specified
in the "changes" but the corresponding value is set to null, that attribute/group is
excluded from the model. If after all properties for a given attribute/group have been
merged that attribute/group ends up being empty (as defined by the isEmpty() method), that
attribute/group is excluded from the merged model.doUnion
- - when true, this merge will be a union of the two maps with some special handling
surrounding null values. If this parameter is false, this merge will be a left join on the
base map. In general, this value should be set to false when doing global merges, and true
when doing partial diff merges.
public static SemanticView filter(SemanticView semanticView, BPCFilter groupFilter, BPCFilter attributeFilter, boolean removeUngroupedAttributes)
semanticView
- - the SemanticView model to be filteredgroupFilter
- - a filter to be applied to the groups collection and the groupOrder list. Only the
groups that pass the filter test will be included. This filter can also be applied to
attributes indirectly depending on the value of the removeUngroupedProperties flagattributeFilter
- - a filter to be applied to the attributes collection. Only the attributes that
pass the filter test will be included. This filter can also be indirectly combined with the
groupFilter depending on the value of the removeUngroupedProperties flag. Additionally, if
this filter is specified, the Groups will be checked to make sure that they only reference
valid attributes. This will always be done to preserve referential integrity of the model.removeUngroupedAttributes
- - this is a rather confusing setting that controls whether or not the
attributes not contained in the groups that remain after filtering should also be removed
from the model. In other words, when this parameter is set to true, an additional
ExclusiveSetFilter
will be created to represent only the attributes contained by the
remaining groups. This new filter will be and-chained with the attributeFilter if necessary.
public static SemanticView createEmptySemanticView(java.lang.String key)
#createEmptyAttributeSettings(int, int)
method instead.
public static SemanticView createEmptySemanticView(java.lang.String key, int attrSize, int groupSize)
attrSize
- - expected size of the attributes collection. This is used to calculate the initial
capacity of the HashMap that contains attributes.groupSize
- - expected size of the groups collection. This is used to calculate the initial
capacity of the HashMap that contains groups.
protected static java.lang.String getDefaultAvailAggregation(java.lang.String datatype, boolean isSingleAssign)
datatype
-
public static java.lang.String getLocalized(java.util.Locale locale, java.lang.String localizedStr, java.lang.String defaultStr)
locale
- locale objectlocalizedStr
- A string contains localized information, the syntax is '{"zh_CN":"Test"}'defaultStr
- The default string
public static java.lang.String getLocalizedDisplayName(com.endeca.mdex.sconfig._2010.types.SemanticAttribute attribute, java.util.Locale locale)
attribute
- locale
-
public static java.lang.String getLocalizedDescription(com.endeca.mdex.sconfig._2010.types.SemanticAttribute attribute, java.util.Locale locale)
attribute
- locale
-
protected static java.util.Map<java.lang.String,SemanticView> getOrLoadViewCache(MDEXState state, RequestIds requestIds, java.util.Locale locale) throws DataSourceException
MDEXState
or (re-)builds this cache if
it has been cleared. This method should only be used by framework
classes. Components should use
)
or
com.endeca.portal.data.DataSource#getAllSemanticViews(Locale))
for caching benefits.
state
- MDEXState object providing service ports for the backend
metadata queriesrequestIds
- RequestIds object used to correlate requests in Timer logginglocale
- Locale to use when generating views
DataSourceException
- if some kind of query error occurred while fetching view
metadataprotected static com.endeca.mdex.sconfig._2010.types.PutEntityResponse putView(SemanticView sView, MDEXState state, RequestIds requestIds, java.util.Locale locale) throws DataSourceException
se
- the semantic entities to add or replacestate
- requestIds
- languageId
-
DataSourceException
protected static com.endeca.mdex.sconfig._2010.types.DeleteEntitiesResponse deleteView(SemanticView sView, MDEXState state, RequestIds requestIds, java.util.Locale locale) throws DataSourceException
sView
- the view to delete; must be a semantic view, not a collectionstate
- requestIds
- languageId
-
DataSourceException
protected static com.endeca.mdex.sconfig._2010.types.ValidateEntityResponse validateView(SemanticView sView, MDEXState state, RequestIds requestIds, java.util.Locale locale) throws DataSourceException
DataSourceException
protected static void clearViewCaches(MDEXState state)
state
- MDEXState
whose cache should be cleared
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |