SemanticView

java.lang.Object
- com.endeca.portal.data.SemanticView

All Implemented Interfaces:

java.lang.Cloneable

Direct Known Subclasses:

CollectionBaseView
```
public class SemanticView
extends java.lang.Object
implements java.lang.Cloneable
```
This class represents the top-level container for the Unified Attribute Model (UAM). It contains attribute and group hash map collections, as well as an ordered list representing the order of groups. Instances of this class can be converted to JSON using Jackson.

Author:

Endeca Technologies,, Inc TODO: make setters and constructors protected

Field Summary

Fields
Modifier and Type	Field and Description
`protected static org.codehaus.jackson.map.ObjectMapper`	`objectMapper`
`static java.lang.String`	`PERMANENT_GROUP_ALL_DN`
`static java.lang.String`	`PERMANENT_GROUP_ALL_KEY`
`static java.lang.String`	`PERMANENT_GROUP_OTHER_DN`
`static java.lang.String`	`PERMANENT_GROUP_OTHER_KEY`

Constructor Summary

Constructors
Constructor and Description
`SemanticView()` Still required for JSON deserialization by components that store SemanticViews as a delta from application-wide defaults.
`SemanticView(java.lang.String viewKey)` Create a new SemanticView.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAllSourceCollections(java.util.Collection<CollectionBaseView> sources)` Adds all source collections at once.
`void`	`addDependentSource(java.lang.String source)`
`SemanticView`	`clone()`
`SemanticView`	`copyBPCs()` This method creates a shallow copy of SemanticView by cloning it's containers (attributes, predefinedMetrics, metadata, groups and GroupOrder).
`java.util.HashMap<java.lang.String,Attribute>`	`dismissAttributes(java.lang.String[] keys)`
`java.util.Map<java.lang.String,Attribute>`	`getAllAttributes()` This should be only called when you want to get all attributes, including the escaped attributes like PRIMARY_KEY.
`Group`	`getAllGroup()` Get all group, create the all group dynamically
`BPCFilter`	`getAttributeFilter()` An AttributeSettings instance can contain pre-constructed BPC filters for attributes and groups.
`java.util.HashMap<java.lang.String,Attribute>`	`getAttributes()` This returns the reduced attributes for default locale only
`java.util.HashMap<java.lang.String,Attribute>`	`getAttributesWithDismissed()`
`java.util.Set<java.lang.String>`	`getDependentSources()`
`java.util.HashMap<java.lang.String,Attribute>`	`getDismissedAttributes()`
`BPCFilter`	`getGroupFilter()` An AttributeSettings instance can contain pre-constructed BPC filters for attributes and groups.
`java.util.List<java.lang.String>`	`getGroupOrder()`
`java.util.HashMap<java.lang.String,Group>`	`getGroups()`
`java.util.HashMap<java.lang.String,Attribute>`	`getHiddenAttributes()` This returns the escaped attributes
`java.lang.String`	`getKey()`
`ViewMetadata`	`getMetadata()`
`java.util.List<java.lang.String>`	`getOtherAttrKeys()`
`Group`	`getOtherGroup()` Get other group, create the other group dynamically
`com.endeca.mdex.eql_parser.types.Query`	`getParsedDefinition()`
`java.lang.String`	`getParsedDefinitionString()`
`java.util.LinkedHashMap<java.lang.String,PredefinedMetric>`	`getPredefinedMetrics()`
`protected com.endeca.endeca_server.sconfig.types.ValidatedSemanticEntity`	`getSemanticEntity()`
`java.util.Set<CollectionBaseView>`	`getSourceCollections()`
`boolean`	`hasSearchableAttribute()`
`boolean`	`isActive()`
`void`	`setActive(boolean isActive)`
`void`	`setAttributeFilter(BPCFilter attributeFilter)`
`void`	`setAttributes(java.util.HashMap<java.lang.String,Attribute> attributes)`
`void`	`setDismissedAttributes(java.util.HashMap<java.lang.String,Attribute> dismissedAttributes)`
`void`	`setGroupFilter(BPCFilter groupFilter)`
`void`	`setGroupOrder(java.util.List<java.lang.String> groupOrder)`
`void`	`setGroups(java.util.HashMap<java.lang.String,Group> groups)`
`void`	`setHiddenAttributes(java.util.HashMap<java.lang.String,Attribute> hiddenAttributes)`
`protected void`	`setKey(java.lang.String viewKey)`
`void`	`setMetadata(ViewMetadata metadata)`
`void`	`setParsedDefinition(com.endeca.mdex.eql_parser.types.Query parsedDefinition)`
`void`	`setParsedDefinitionString(java.lang.String parsedDefinitionStr)`
`void`	`setPredefinedMetrics(java.util.LinkedHashMap<java.lang.String,PredefinedMetric> predefinedMetrics)`
`protected void`	`setSemanticEntity(com.endeca.endeca_server.sconfig.types.ValidatedSemanticEntity se)`
`void`	`setSourceCollections(java.util.Collection<CollectionBaseView> sources)`
`void`	`sortGroups()` Sorts the group order list in place based on the following business rules: General group should bubble to the top; Other group should fall to last position.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PERMANENT_GROUP_ALL_KEY
```
public static final java.lang.String PERMANENT_GROUP_ALL_KEY
```
    See Also:
    Constant Field Values
  - PERMANENT_GROUP_ALL_DN
```
public static final java.lang.String PERMANENT_GROUP_ALL_DN
```
    See Also:
    Constant Field Values
  - PERMANENT_GROUP_OTHER_KEY
```
public static final java.lang.String PERMANENT_GROUP_OTHER_KEY
```
    See Also:
    Constant Field Values
  - PERMANENT_GROUP_OTHER_DN
```
public static final java.lang.String PERMANENT_GROUP_OTHER_DN
```
    See Also:
    Constant Field Values
  - objectMapper
```
protected static org.codehaus.jackson.map.ObjectMapper objectMapper
```
- Constructor Detail
  - SemanticView
```
public SemanticView()
```
    Still required for JSON deserialization by components that store SemanticViews as a delta from application-wide defaults.
  - SemanticView
```
public SemanticView(java.lang.String viewKey)
```
    Create a new SemanticView.
    
    Parameters:
    viewKey -
- Method Detail
  - setKey
```
protected void setKey(java.lang.String viewKey)
```
  - getKey
```
public java.lang.String getKey()
```
  - setSemanticEntity
```
protected void setSemanticEntity(com.endeca.endeca_server.sconfig.types.ValidatedSemanticEntity se)
```
  - getSemanticEntity
```
protected com.endeca.endeca_server.sconfig.types.ValidatedSemanticEntity getSemanticEntity()
```
  - setAttributes
```
public void setAttributes(java.util.HashMap<java.lang.String,Attribute> attributes)
```
    Parameters:
    attributes - the attributes to set
  - getAttributes
```
public java.util.HashMap<java.lang.String,Attribute> getAttributes()
```
    This returns the reduced attributes for default locale only
    
    Returns:
    the attributes
  - getAttributesWithDismissed
```
public java.util.HashMap<java.lang.String,Attribute> getAttributesWithDismissed()
```
  - setDismissedAttributes
```
public void setDismissedAttributes(java.util.HashMap<java.lang.String,Attribute> dismissedAttributes)
```
  - getDismissedAttributes
```
public java.util.HashMap<java.lang.String,Attribute> getDismissedAttributes()
```
  - dismissAttributes
```
public java.util.HashMap<java.lang.String,Attribute> dismissAttributes(java.lang.String[] keys)
```
  - getHiddenAttributes
```
public java.util.HashMap<java.lang.String,Attribute> getHiddenAttributes()
```
    This returns the escaped attributes
    
    Returns:
    the attributes
  - setHiddenAttributes
```
public void setHiddenAttributes(java.util.HashMap<java.lang.String,Attribute> hiddenAttributes)
```
    Parameters:
    attributes - the escaped attributes to set
  - getAllAttributes
```
public java.util.Map<java.lang.String,Attribute> getAllAttributes()
```
    This should be only called when you want to get all attributes, including the escaped attributes like PRIMARY_KEY. Otherwise, call getAttributes() instead to hide the escaped attributes.
    
    Returns:
    all the attributes including the escaped ones (e.g. PRIMARY_KEY)
  - setGroups
```
public void setGroups(java.util.HashMap<java.lang.String,Group> groups)
```
    Parameters:
    groups - the groups to set
  - getGroups
```
public java.util.HashMap<java.lang.String,Group> getGroups()
```
    Returns:
    the groups
  - setGroupOrder
```
public void setGroupOrder(java.util.List<java.lang.String> groupOrder)
```
    Parameters:
    groupOrder - the groupOrder to set
  - getGroupOrder
```
public java.util.List<java.lang.String> getGroupOrder()
```
    Returns:
    the groupOrder
  - isActive
```
public boolean isActive()
```
  - setActive
```
public void setActive(boolean isActive)
```
  - setAttributeFilter
```
public void setAttributeFilter(BPCFilter attributeFilter)
```
    Parameters:
    attributeFilter - the attributeFilter to set
  - getAttributeFilter
```
public BPCFilter getAttributeFilter()
```
    An AttributeSettings instance can contain pre-constructed BPC filters for attributes and groups. These filter objects can be used as a convenience mechanism for storing a filter constructed based on the information contained in the global settings. These filter objects will be cached along with this AttributeSettings instance and can be reused by various portlets during merging.
    
    Returns:
    the attribute filter or null if it has not been set
  - setGroupFilter
```
public void setGroupFilter(BPCFilter groupFilter)
```
    Parameters:
    groupFilter - the groupFilter to set
  - getGroupFilter
```
public BPCFilter getGroupFilter()
```
    An AttributeSettings instance can contain pre-constructed BPC filters for attributes and groups. These filter objects can be used as a convenience mechanism for storing a filter constructed based on the information contained in the global settings. These filter objects will be cached along with this AttributeSettings instance and can be reused by various portlets during merging.
    
    Returns:
    the group filter or null if it has not been set
  - getPredefinedMetrics
```
public java.util.LinkedHashMap<java.lang.String,PredefinedMetric> getPredefinedMetrics()
```
  - setPredefinedMetrics
```
public void setPredefinedMetrics(java.util.LinkedHashMap<java.lang.String,PredefinedMetric> predefinedMetrics)
```
  - getMetadata
```
public ViewMetadata getMetadata()
```
  - setMetadata
```
public void setMetadata(ViewMetadata metadata)
```
  - getParsedDefinitionString
```
public java.lang.String getParsedDefinitionString()
```
  - setParsedDefinitionString
```
public void setParsedDefinitionString(java.lang.String parsedDefinitionStr)
```
  - getParsedDefinition
```
public com.endeca.mdex.eql_parser.types.Query getParsedDefinition()
```
  - setParsedDefinition
```
public void setParsedDefinition(com.endeca.mdex.eql_parser.types.Query parsedDefinition)
```
  - getAllGroup
```
public Group getAllGroup()
```
    Get all group, create the all group dynamically
    
    Returns:
  - getOtherGroup
```
public Group getOtherGroup()
```
    Get other group, create the other group dynamically
    
    Returns:
  - sortGroups
```
public void sortGroups()
```
    Sorts the group order list in place based on the following business rules: General group should bubble to the top; Other group should fall to last position. Otherwise alpha order.
  - addAllSourceCollections
```
public void addAllSourceCollections(java.util.Collection<CollectionBaseView> sources)
```
    Adds all source collections at once.
    
    Parameters:
    sourceCollections - a Collection of CollectionBaseViews
    
    Throws:
    
    java.lang.IllegalArgumentException - if specified Collection is null
  - setSourceCollections
```
public void setSourceCollections(java.util.Collection<CollectionBaseView> sources)
```
  - getSourceCollections
```
public java.util.Set<CollectionBaseView> getSourceCollections()
```
  - addDependentSource
```
public void addDependentSource(java.lang.String source)
```
  - getDependentSources
```
public java.util.Set<java.lang.String> getDependentSources()
```
  - hasSearchableAttribute
```
public boolean hasSearchableAttribute()
```
  - getOtherAttrKeys
```
public java.util.List<java.lang.String> getOtherAttrKeys()
```
  - copyBPCs
```
public SemanticView copyBPCs()
```
    This method creates a shallow copy of SemanticView by cloning it's containers (attributes, predefinedMetrics, metadata, groups and GroupOrder). The members of these containers are added by reference, so any change to these will be changed in both the new copy and the existing version. However, this method will allow you to add/delete members of these containers without effecting the original version.
    
    Returns:
    SemanticView
  - clone
```
public SemanticView clone()
```
    Overrides:
    
    clone in class java.lang.Object

Class SemanticView

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PERMANENT_GROUP_ALL_KEY

PERMANENT_GROUP_ALL_DN

PERMANENT_GROUP_OTHER_KEY

PERMANENT_GROUP_OTHER_DN

objectMapper

Constructor Detail

SemanticView

SemanticView

Method Detail

setKey

getKey

setSemanticEntity

getSemanticEntity

setAttributes

getAttributes

getAttributesWithDismissed

setDismissedAttributes

getDismissedAttributes

dismissAttributes

getHiddenAttributes

setHiddenAttributes

getAllAttributes

setGroups

getGroups

setGroupOrder

getGroupOrder

isActive

setActive

setAttributeFilter

getAttributeFilter

setGroupFilter

getGroupFilter

getPredefinedMetrics

setPredefinedMetrics

getMetadata

setMetadata

getParsedDefinitionString

setParsedDefinitionString

getParsedDefinition

setParsedDefinition

getAllGroup

getOtherGroup

sortGroups

addAllSourceCollections

setSourceCollections

getSourceCollections

addDependentSource

getDependentSources

hasSearchableAttribute

getOtherAttrKeys

copyBPCs

clone