Package net.ontopia.topicmaps.nav2.portlets.pojos

Class RelatedTopics

java.lang.Object
net.ontopia.topicmaps.nav2.portlets.pojos.RelatedTopics
public class RelatedTopics extends Object
PUBLIC: This component can produce a model representing the associations of a given topic.

  • Field Details

    • ORDERING_ASC

      public static final int ORDERING_ASC
      PUBLIC: Flag used to indicated ascending ordering.
      See Also:

    • ORDERING_DESC

      public static final int ORDERING_DESC
      PUBLIC: Flag used to indicated descending ordering.
      See Also:

  • Constructor Details

    • RelatedTopics

      public RelatedTopics()

  • Method Details

    • setWeakAssociationTypes

      public void setWeakAssociationTypes(Set weaktypes)
      PUBLIC: Set the set of association types which is to be considered weak in the sense that associations of these types are to be listed under the heading for the topic type of the associated topics, and not under the association type.

    • setExcludeAssociationTypes

      public void setExcludeAssociationTypes(Set types)
      PUBLIC: Set the set of association types which is not to be shown.

    • setExcludeRoleTypes

      public void setExcludeRoleTypes(Set types)
      PUBLIC: Set the set of near roles types which is not to be included.
      Since:
      3.4.2

    • setExcludeTopicTypes

      public void setExcludeTopicTypes(Set types)
      PUBLIC: Set the set of topic types which is not to be shown. For n-ary associations the filter takes effect if any of the roles are played by excluded types.

    • setIncludeAssociationTypes

      public void setIncludeAssociationTypes(Set types)
      PUBLIC: Set the set of association types which is to be shown.

    • setIncludeTopicTypes

      public void setIncludeTopicTypes(Set types)
      PUBLIC: Set the set of topic types which is to be shown. For n-ary associations the filter takes effect if any of the roles are not played by included types.

    • setFilterQuery

      public void setFilterQuery(String query)
      PUBLIC: Sets a query to be used to filter topics shown as related. Only topics for which the query does not return any rows will be shown.

    • setMaxChildren

      public void setMaxChildren(int maxchildren)
      PUBLIC: Sets the maximum number of children for a heading to show by default. A negative value will show all children.
      Since:
      3.4

    • setHeadingOrderQuery

      public void setHeadingOrderQuery(String headingOrderQueryString)
      PUBLIC: Sets the query to use to get the sort key of each heading topic.
      Since:
      3.4

    • setHeadingOrdering

      public void setHeadingOrdering(int headingOrdering)
      PUBLIC: Sets the ordering direction to be used for headings.
      Since:
      3.4.1

    • setChildOrderQuery

      public void setChildOrderQuery(String childOrderQueryString)
      PUBLIC: Sets the query to use to get the sort key of each child topic.
      Since:
      3.4

    • setChildOrdering

      public void setChildOrdering(int childOrdering)
      PUBLIC: Sets the ordering direction to be used for children.
      Since:
      3.4.1

    • setAggregateHierarchy

      public void setAggregateHierarchy(boolean aggregateHierarchy)
      PUBLIC: Sets the flag indicating whether to do hierarchy aggregation or not.
      Since:
      3.4.2

    • setAggregateAssociations

      public void setAggregateAssociations(Set aggregateAssociations)
      PUBLIC: Sets the association types to do hierarchy aggregation for.
      Since:
      3.4.2

    • setTologContext

      public void setTologContext(DeclarationContextIF tologctx)
      PUBLIC: Passes in a tolog declaration context to be used when parsing tolog queries.
      Since:
      3.4.2

    • makeModel

      public List makeModel(TopicIF topic)
      PUBLIC: Builds a model representing the associations of the given topic.
      Returns:
      a list of Heading objects

    • setUseOntopolyNames

      public void setUseOntopolyNames(boolean useOntopolyNames)