org.wandora.topicmap

Class TopicTools

java.lang.Object

org.wandora.topicmap.TopicTools

public class TopicTools
extends java.lang.Object

This class is a collection of static helpers for accessing topics and associations.

Author:

akivela

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	dchars
static int	locatorCounter
static java.lang.String	nameOfInstanceType
static java.lang.String	nameOfTypeType
static java.lang.String	schars

Constructor Summary

Constructors

Constructor and Description
TopicTools() Creates a new instance of TopicTools

Method Summary

Modifier and Type	Method and Description
static Locator	cleanDirtyLocator(Locator l)
static java.lang.String	cleanDirtyLocator(java.lang.String s) Removes or replaces all "dirty" characters in the string.
static Locator	createDefaultLocator() Returns a default locator that can be given to a topic and it is very likely (but not sure) that the subject identifier doesn't cause accidental merge.
static java.lang.String[]	getAssociationsAsTriplets(Topic t) Returns a flat string array that contains associations (including classes and instances) of a given topic.
static java.lang.String[]	getAssociationsAsTypePlayerTuples(Topic t) Returns a flat string array that contains associations (including classes and instances) of a given topic.
static java.lang.String[]	getAsTriplet(Association a) Returns given association as a string array where first element is association type and next elements association player topics.
private static void	getCyclePaths(java.util.List<java.util.List<Topic>> cycles, java.util.List<Topic> path, Topic base, Topic associationType, Topic baseRole, Topic outRole)
static java.util.List<java.util.List<Topic>>	getCyclePaths(Topic base, Topic associationType, Topic baseRole, Topic outRole) Returns possible paths where one can traverse given associations back to the starting topic.
static Topic	getEdgeTopic(Topic base, Topic associationType, Topic baseRole, Topic outRole) Return one edge topic.
static java.util.Collection<Topic>	getEdgeTopics(java.util.Collection<Topic> source, Topic associationType, Topic baseRole, Topic outRole) Return a collection of topics.
static Topic	getFirstPlayer(Topic topic, java.lang.String associationTypeSI, java.lang.String roleSI) Get one player in the associations of given type in the topic that is of given role.
static Topic	getFirstPlayerWithRole(Topic topic, java.lang.String roleSI) Returns one player of given role in the associations of the topic.
static java.util.List<Layer>	getLayers(ContainerTopicMap tm) Returns a list of topic map layers of given container topic map.
static java.util.List<Topic>	getPlayers(java.util.Collection topics, java.lang.String associationTypeSI, java.lang.String roleSI) Get all players of associations of a given topics.
static java.util.List<Topic>	getPlayers(java.util.Collection topics, java.lang.String associationTypeSI, java.lang.String roleSI, java.lang.String hasRole, java.lang.String hasPlayer) Get all players of topics if next conditions apply: Association type must be same as argument associationTypeSI.
static java.util.List<Topic>	getPlayers(Topic topic, java.lang.String associationTypeSI) Get all players of all associations of a given type in the topic.
static java.util.List<Topic>	getPlayers(Topic topic, java.lang.String associationTypeSI, java.lang.String roleSI) Get all player topics within associations of a given topic.
static java.util.List<Topic>	getPlayers(Topic topic, java.lang.String associationTypeSI, java.lang.String roleSI, java.lang.String hasRole, java.lang.String hasPlayer) Get all players of a topic if next conditions apply: Association type must be same as argument associationTypeSI.
static java.util.List<Topic>	getPlayers(Topic topic, Topic associationType, Topic role) Return a list of topics.
static java.util.List<Topic>	getPlayers(Topic topic, Topic type, Topic role, Topic hasRole, Topic hasPlayer) Get all players of a topic if next conditions apply: Association type must be same as argument type.
static java.util.List<Topic>	getPlayersWithRole(java.util.Collection topics, java.lang.String roleSI) Get all players of given role in the associations of a collection of topics.
static java.util.List<Topic>	getPlayersWithRole(Topic topic, java.lang.String roleSI) Get all players of given role in the associations of the topic.
static java.util.List<Topic>	getPlayersWithRoles(java.util.Collection topics, java.util.Collection roleSIs) Get all players with one of specified roles in the associations of topics in the collection.
static java.util.List<Topic>	getPlayersWithRoles(java.util.Collection topics, java.lang.String[] roleSIs) Get all players with one of specified roles in the associations of topics in the collection.
static java.util.List<Topic>	getPlayersWithRoles(Topic topic, java.util.Collection roleSIs) Get all players with one of specified roles in the associations of the topic.
static java.util.List<Topic>	getPlayersWithRoles(Topic topic, java.lang.String[] roleSIs) Get all players with one of specified roles in the associations of the topic.
static java.util.List<Topic>	getSinglePath(Topic base, Topic associationType, Topic baseRole, Topic outRole) Returns one path (a list of topics) that is created traversing associations from a given start point to the end point.
static java.util.List<java.lang.String>	getSLsOfPlayers(Topic topic, java.lang.String associationTypeSI, java.lang.String roleSI)
static java.util.List<java.lang.String>	getSLsOfTopics(java.util.Collection topics) Returns a list subject locators of given topics.
static java.util.List<Topic>	getSortedPlayers(Topic topic, java.util.Collection associationTypesSI, java.util.Collection rolesSI, java.lang.String sortRole, java.lang.String lang) Gets a sorted list of player topics of a given topic and association types and roles.
static java.util.List<Topic>	getSortedPlayers(Topic topic, java.lang.String associationTypeSI, java.lang.String roleSI, java.lang.String sortRole, java.lang.String lang) Gets a sorted list of player topics of a given topic and association type and role.
static java.util.List<java.lang.String>	getSubjectLocatorsOfPlayers(Topic topic, java.lang.String associationTypeSI, java.lang.String roleSI)
static java.util.List<java.lang.String>	getSubjectLocatorsOfTopics(java.util.Collection topics) Returns a list subject locators of given topics.
static java.lang.String	getTopicName(Topic t) Returns topic's base name if base name exists.
static java.util.List<Topic>	getTypesOfRequiredType(Topic topic, java.lang.String requiredTypeSI) Returns a list of type topics of a given topic.
static boolean	isDirtyLocator(Locator l) Checks if given locator contains unwanted characters that make the locator "dirty".
static boolean	isDirtyLocatorCharacter(char c) Method isDirtyLocator uses this method to decide whether or not a character is "dirty".
static boolean	isTopicMapContainer(TopicMap tm) Checks if a given topic map is a container topic map.
static char	repacementLocatorCharacterFor(char c) Finds a suitable replacement character for some "dirty" characters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

schars

public static java.lang.String schars

dchars

public static java.lang.String dchars

locatorCounter

public static int locatorCounter

nameOfInstanceType

public static final java.lang.String nameOfInstanceType

See Also:

Constant Field Values

nameOfTypeType

public static final java.lang.String nameOfTypeType

See Also:

Constant Field Values

Constructor Detail

TopicTools

public TopicTools()

Creates a new instance of TopicTools

Method Detail

getFirstPlayerWithRole

public static Topic getFirstPlayerWithRole(Topic topic,
                                           java.lang.String roleSI)

Returns one player of given role in the associations of the topic.

Parameters:

topic -

roleSI -

Returns:

getPlayersWithRole

public static java.util.List<Topic> getPlayersWithRole(Topic topic,
                                                       java.lang.String roleSI)
                                                throws TopicMapException

Get all players of given role in the associations of the topic.

Parameters:

topic -

roleSI -

Returns:

Throws:

TopicMapException

getPlayersWithRole

public static java.util.List<Topic> getPlayersWithRole(java.util.Collection topics,
                                                       java.lang.String roleSI)

Get all players of given role in the associations of a collection of topics. Returned topic list may contain same topic several times (TODO: is this intended?).

Parameters:

topics -

roleSI -

Returns:

getPlayersWithRoles

public static java.util.List<Topic> getPlayersWithRoles(Topic topic,
                                                        java.lang.String[] roleSIs)

Get all players with one of specified roles in the associations of the topic.

Parameters:

topic -

roleSIs -

Returns:

getPlayersWithRoles

public static java.util.List<Topic> getPlayersWithRoles(Topic topic,
                                                        java.util.Collection roleSIs)

Get all players with one of specified roles in the associations of the topic.

Parameters:

topic -

roleSIs -

Returns:

getPlayersWithRoles

public static java.util.List<Topic> getPlayersWithRoles(java.util.Collection topics,
                                                        java.util.Collection roleSIs)

Get all players with one of specified roles in the associations of topics in the collection.

Parameters:

topics -

roleSIs -

Returns:

getPlayersWithRoles

public static java.util.List<Topic> getPlayersWithRoles(java.util.Collection topics,
                                                        java.lang.String[] roleSIs)

Get all players with one of specified roles in the associations of topics in the collection.

Parameters:

topics -

roleSIs -

Returns:

getPlayers

public static java.util.List<Topic> getPlayers(Topic topic,
                                               java.lang.String associationTypeSI)
                                        throws TopicMapException

Get all players of all associations of a given type in the topic.

Parameters:

topic -

associationTypeSI -

Returns:

Throws:

TopicMapException

getFirstPlayer

public static Topic getFirstPlayer(Topic topic,
                                   java.lang.String associationTypeSI,
                                   java.lang.String roleSI)

Get one player in the associations of given type in the topic that is of given role.

Parameters:

topic -

associationTypeSI -

roleSI -

Returns:

getPlayers

public static java.util.List<Topic> getPlayers(Topic topic,
                                               java.lang.String associationTypeSI,
                                               java.lang.String roleSI)
                                        throws TopicMapException

Get all player topics within associations of a given topic. Associations are limited to a given association type and player to a given role.

Parameters:

topic -

associationTypeSI -

roleSI -

Returns:

Throws:

TopicMapException

getPlayers

public static java.util.List<Topic> getPlayers(Topic topic,
                                               Topic associationType,
                                               Topic role)
                                        throws TopicMapException

Return a list of topics. List contains player topics within associations of a given topic. Associations are limited with an association type and player with a role topic.

Parameters:

topic -

associationType -

role -

Returns:

Throws:

TopicMapException

getPlayers

public static java.util.List<Topic> getPlayers(java.util.Collection topics,
                                               java.lang.String associationTypeSI,
                                               java.lang.String roleSI)

Get all players of associations of a given topics. Associations are limited to a given type. Players are limited to a given role.

Parameters:

topics -

associationTypeSI -

roleSI -

Returns:

getPlayers

public static java.util.List<Topic> getPlayers(Topic topic,
                                               java.lang.String associationTypeSI,
                                               java.lang.String roleSI,
                                               java.lang.String hasRole,
                                               java.lang.String hasPlayer)
                                        throws TopicMapException

Get all players of a topic if next conditions apply: Association type must be same as argument associationTypeSI. Player's role must be same as argument roleSI. Association must contain role-player pair that specified with arguments hasRole and hasPlayer.

Parameters:

topic -

associationTypeSI -

roleSI -

hasRole -

hasPlayer -

Returns:

Throws:

TopicMapException

getPlayers

public static java.util.List<Topic> getPlayers(Topic topic,
                                               Topic type,
                                               Topic role,
                                               Topic hasRole,
                                               Topic hasPlayer)
                                        throws TopicMapException

Get all players of a topic if next conditions apply: Association type must be same as argument type. Player's role must be same as argument role. Association must contain role-player pair that specified with arguments hasRole and hasPlayer.

Parameters:

topic -

type -

role -

hasRole -

hasPlayer -

Returns:

Throws:

TopicMapException

getPlayers

public static java.util.List<Topic> getPlayers(java.util.Collection topics,
                                               java.lang.String associationTypeSI,
                                               java.lang.String roleSI,
                                               java.lang.String hasRole,
                                               java.lang.String hasPlayer)
                                        throws TopicMapException

Get all players of topics if next conditions apply: Association type must be same as argument associationTypeSI. Player's role must be same as argument roleSI. Association must contain role-player pair that specified with arguments hasRole and hasPlayer.

Parameters:

topics -

associationTypeSI -

roleSI -

hasRole -

hasPlayer -

Returns:

Throws:

TopicMapException

getSortedPlayers

public static java.util.List<Topic> getSortedPlayers(Topic topic,
                                                     java.lang.String associationTypeSI,
                                                     java.lang.String roleSI,
                                                     java.lang.String sortRole,
                                                     java.lang.String lang)
                                              throws TopicMapException

Gets a sorted list of player topics of a given topic and association type and role. Argument sortRole is used to pick up sorting player topic. Argument lang is used to get sort name out of sorting player topic.

Parameters:

topic -

associationTypeSI -

roleSI -

sortRole -

lang -

Returns:

Throws:

TopicMapException

getSortedPlayers

public static java.util.List<Topic> getSortedPlayers(Topic topic,
                                                     java.util.Collection associationTypesSI,
                                                     java.util.Collection rolesSI,
                                                     java.lang.String sortRole,
                                                     java.lang.String lang)
                                              throws TopicMapException

Gets a sorted list of player topics of a given topic and association types and roles. Argument sortRole is used to pick up sorting player topic. Argument lang is used to get sort name out of sorting player topic.

Parameters:

topic -

associationTypesSI -

rolesSI -

sortRole -

lang -

Returns:

Throws:

TopicMapException

getTypesOfRequiredType

public static java.util.List<Topic> getTypesOfRequiredType(Topic topic,
                                                           java.lang.String requiredTypeSI)

Returns a list of type topics of a given topic. List of type topics is limited to topics that have them selves typed with requiredTypeSi.

Parameters:

topic -

requiredTypeSI -

Returns:

getSLsOfPlayers

public static java.util.List<java.lang.String> getSLsOfPlayers(Topic topic,
                                                               java.lang.String associationTypeSI,
                                                               java.lang.String roleSI)
                                                        throws TopicMapException

Throws:

TopicMapException

getSubjectLocatorsOfPlayers

public static java.util.List<java.lang.String> getSubjectLocatorsOfPlayers(Topic topic,
                                                                           java.lang.String associationTypeSI,
                                                                           java.lang.String roleSI)
                                                                    throws TopicMapException

Throws:

TopicMapException

getSLsOfTopics

public static java.util.List<java.lang.String> getSLsOfTopics(java.util.Collection topics)

Returns a list subject locators of given topics. Delegates operation to method getSubjectLocatorsOfTopics.

Parameters:

topics -

Returns:

getSubjectLocatorsOfTopics

public static java.util.List<java.lang.String> getSubjectLocatorsOfTopics(java.util.Collection topics)

Returns a list subject locators of given topics. If a topic has no subject locator, the list has no element for the topic.

Parameters:

topics -

Returns:

getEdgeTopics

public static java.util.Collection<Topic> getEdgeTopics(java.util.Collection<Topic> source,
                                                        Topic associationType,
                                                        Topic baseRole,
                                                        Topic outRole)

Return a collection of topics. Returned topics are edges of an association chain. Association chain is topic path where one travels from a given topic through given associations (association type, in-role and out-role). Edge topic is found whenever one can not travel any further.

Parameters:

source -

associationType -

baseRole -

outRole -

Returns:

getEdgeTopic

public static Topic getEdgeTopic(Topic base,
                                 Topic associationType,
                                 Topic baseRole,
                                 Topic outRole)

Return one edge topic.

Parameters:

base -

associationType -

baseRole -

outRole -

Returns:

getSinglePath

public static java.util.List<Topic> getSinglePath(Topic base,
                                                  Topic associationType,
                                                  Topic baseRole,
                                                  Topic outRole)

Returns one path (a list of topics) that is created traversing associations from a given start point to the end point.

Parameters:

base -

associationType -

baseRole -

outRole -

Returns:

getCyclePaths

public static java.util.List<java.util.List<Topic>> getCyclePaths(Topic base,
                                                                  Topic associationType,
                                                                  Topic baseRole,
                                                                  Topic outRole)

Returns possible paths where one can traverse given associations back to the starting topic.

Parameters:

base -

associationType -

baseRole -

outRole -

Returns:

getCyclePaths

private static void getCyclePaths(java.util.List<java.util.List<Topic>> cycles,
                                  java.util.List<Topic> path,
                                  Topic base,
                                  Topic associationType,
                                  Topic baseRole,
                                  Topic outRole)

isDirtyLocator

public static boolean isDirtyLocator(Locator l)

Checks if given locator contains unwanted characters that make the locator "dirty".

Parameters:

l -

Returns:

isDirtyLocatorCharacter

public static boolean isDirtyLocatorCharacter(char c)

Method isDirtyLocator uses this method to decide whether or not a character is "dirty".

Parameters:

c -

Returns:

repacementLocatorCharacterFor

public static char repacementLocatorCharacterFor(char c)

Finds a suitable replacement character for some "dirty" characters.

Parameters:

c -

Returns:

cleanDirtyLocator

public static java.lang.String cleanDirtyLocator(java.lang.String s)

Removes or replaces all "dirty" characters in the string.

Parameters:

s -

Returns:

cleanDirtyLocator

public static Locator cleanDirtyLocator(Locator l)

createDefaultLocator

public static Locator createDefaultLocator()

Returns a default locator that can be given to a topic and it is very likely (but not sure) that the subject identifier doesn't cause accidental merge. Default locator is created with a prefix "http://wandora.org/si/temp/", timestamp and locator counter.

Returns:

getTopicName

public static java.lang.String getTopicName(Topic t)

Returns topic's base name if base name exists. Otherwise returns topic's first subject identifier.

Parameters:

t -

Returns:

getAssociationsAsTriplets

public static java.lang.String[] getAssociationsAsTriplets(Topic t)

Returns a flat string array that contains associations (including classes and instances) of a given topic. Every n*3:th element of the string array is argument topic's name. Every n*3+1:th element of the array is association type's name and every n*3+2:th element of the array is associated topic's name. Role topic's are not included in the array.

Parameters:

t -

Returns:

getAssociationsAsTypePlayerTuples

public static java.lang.String[] getAssociationsAsTypePlayerTuples(Topic t)

Returns a flat string array that contains associations (including classes and instances) of a given topic. Associations are stored as type-player pairs. Every odd element of the string array is type topic's name. Every even element of the string array is player topic's name. Role topics are not stored in the string array.

Parameters:

t -

Returns:

getAsTriplet

public static java.lang.String[] getAsTriplet(Association a)

Returns given association as a string array where first element is association type and next elements association player topics. Returned string array doesn't contain role topics.

Parameters:

a -

Returns:

getLayers

public static java.util.List<Layer> getLayers(ContainerTopicMap tm)

Returns a list of topic map layers of given container topic map. For example, Wandora's layer stack is a container topic map and the method returns all topic maps in the layer stack.

Parameters:

tm -

Returns:

isTopicMapContainer

public static boolean isTopicMapContainer(TopicMap tm)

Checks if a given topic map is a container topic map. Container topic map can contain other topics maps. For example, Wandora's layer stack is a container topic map.

Parameters:

tm -

Returns: