Package mc.core.model.channel

Class Navigation

java.lang.Object
mc.core.model.base.EntityBase
mc.core.model.base.ComplexEntity
mc.core.model.base.HrcEntity
mc.core.model.channel.Navigation
All Implemented Interfaces:
Serializable, IBaseEntity, ICoreEntity, IEntity, IHrcManaged<Navigation>, ISortableEntity, ITypeManaged
@Entity public class Navigation extends HrcEntity implements ITypeManaged, IHrcManaged<Navigation>
Entity representing an element of a navigation tree. A navigation tree or hierarchy is created to structure the data for publication. A Navigation always belongs to only one NavigationHrc and has a parent navigation unless it is a root element. Navigation must have a NavigationType which provides configuration info as well as the level of the Navigation.
Nodes can be assigned directly to Navigations in order to give them a place in the navigation structure. Another approach is to assign a Classification to the Navigation. During publication all Nodes assigned to the Classification will be exported with the Navigation.
See Also:

  • Constructor Details

    • Navigation

      public Navigation()

    • Navigation

      public Navigation(Navigation source)

  • Method Details

    • getNavigationType

      public NavigationType getNavigationType()

    • setNavigationType

      public void setNavigationType(NavigationType navigationType)

    • setType

      public void setType(ComplexTypeEntity type)
      Description copied from class: ComplexEntity
      override in derived classes if ComplexEntity-subclass is type managed, else do nothing.
      be used by entity mapper
      Overrides:
      setType in class ComplexEntity

    • getNavigationHrc

      public NavigationHrc getNavigationHrc()

    • setNavigationHrc

      public void setNavigationHrc(NavigationHrc navigationHrc)

    • getNodes

      public List<NavigationToNode> getNodes()

    • setNodes

      public void setNodes(List<NavigationToNode> nodes)

    • getClassification

      public Classification getClassification()
      Navigation can either assign to a list of Nodes or to a classification.

    • setClassification

      public void setClassification(Classification classification)

    • getType

      public ComplexTypeEntity getType()
      Description copied from class: ComplexEntity
      override in derived classes, return null if ComplexEntity-subclass is not type managed.
      Specified by:
      getType in interface ITypeManaged
      Specified by:
      getType in class ComplexEntity

    • getHrc

      public ComplexEntity getHrc()
      Description copied from class: HrcEntity
      override in derived classes
      return hierarchy
      Specified by:
      getHrc in class HrcEntity

    • hrcChildren

      public List<Navigation> hrcChildren()
      Description copied from interface: IHrcManaged
      typesafe retrieval of HrcEntity children. never return proxies
      Specified by:
      hrcChildren in interface IHrcManaged<Navigation>
      Returns:
      typesafe list of children entities or empty list. never null

    • hrcVisibleChildren

      public List<Navigation> hrcVisibleChildren()
      Description copied from interface: IHrcManaged
      typesafe retrieval of HrcEntity visible children (filtered on life cycle flag visible)
      never return proxies
      Specified by:
      hrcVisibleChildren in interface IHrcManaged<Navigation>
      Returns:
      typesafe list of children entities or empty list. never null

    • hrcParent

      public Navigation hrcParent()
      Description copied from interface: IHrcManaged
      typesafe retrieval of HrcEntity parent. never return proxy. use this preferable over getParent() if you want access type special properties or use entity class, instead of safeCast to target type yourself. still use getParent() if you only need the id, cause no need to initialize (load) proxy then
      Specified by:
      hrcParent in interface IHrcManaged<Navigation>
      Returns:
      parent entity or null

    • hrcParents

      public List<Navigation> hrcParents()
      Description copied from interface: IHrcManaged
      typesafe retrieval of HrcEntity parents. never return proxies. use this if you want access type special properties or use entity class, instead of safeCast to target type yourself
      Specified by:
      hrcParents in interface IHrcManaged<Navigation>
      Overrides:
      hrcParents in class HrcEntity
      Returns:
      Parents starting from root up to (but not including) this HrcEntity.

    • hrcPath

      public List<Navigation> hrcPath()
      Description copied from interface: IHrcManaged
      typesafe retrieval of HrcEntity parents plus entity itself. never return proxies. use this if you want access type special properties or use entity class, instead of safeCast to target type yourself
      Specified by:
      hrcPath in interface IHrcManaged<Navigation>
      Overrides:
      hrcPath in class HrcEntity
      Returns:
      List of ancestors starting with root ancestor and including ourself at the end
      See Also: