org.wandora.topicmap

Class SchemaBox

java.lang.Object

org.wandora.topicmap.SchemaBox

public class SchemaBox
extends java.lang.Object

SchemaBox contains many high level methods related to the proprietary topic map schema used by Wandora. Some of these methods include:

• Methods to get subclasses and superclasses of a topic. The standard superclass-subclass, superclass and subclass topics are used as association type and association roles respectively.
• Methods to check if a topic has as one of its types a specific class topic or any of its subclasses, subsubclasses etc. That is, subclasses behave as if they inherited all properties of their super classes. Thus if a topic is an instance of a class topic, it is also instance of all the superclasses of the classtopic, and instance of superclasses of those.
• Methods to get content types of a topic taking into account inheritance through superclasses. Topic A is content type of topic B if A is of type content type and B is an instance of A as specified in previous point in this list. That is B doesn't have to be a direct instance of A but can be an instance of some other topic that is a subclass (possibly through many associations) of A.
• Methods to get possible association types for a topic. Each content type defines what associations that type of topic may have. Possible association types for a topic are all the association types specified by all its content types.
• Similar methods for occurrence types.
• A method to get role topics for an association type. The association type topic specifies which topics can be used as roles of associations of that type. This method gets those role topics.

Author:

olli

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANY_SI
static java.lang.String	ASSOCIATIONTYPE_SI
static java.lang.String	CONTENTTYPE_SI
static int	COUNT_ATLEASTONE
static int	COUNT_ATMOSTONE
static int	COUNT_MULTIPLE
static int	COUNT_SINGLE
static java.lang.String	DEFAULT_ASSOCIATION_SI
static java.lang.String	DEFAULT_OCCURRENCE_SI
static java.lang.String	DEFAULT_ROLE_1_SI
static java.lang.String	DEFAULT_ROLE_2_SI
static java.lang.String	OCCURRENCETYPE_SI
static java.lang.String	ROLE_SI
static java.lang.String	ROLECLASS_SI

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static java.util.Collection	getAssociationTypeRoles(Topic associationType) Gets all roles that can be used with the specified association type.
static java.util.Collection	getAssociationTypesFor(Topic topic) Gets all association types that can be used with the specified topic.
static java.util.Collection	getContentTypesOf(Topic topic) Gets all content types of this class is an instance of.
private static void	getContentTypesOfNoSupers(Topic topic, java.util.Collection processed, java.util.Collection types, Topic contenttype)
static java.util.Collection	getInstancesOf(Topic topic) Gets all instances of a class topic.
private static void	getInstancesOf(Topic topic, java.util.Collection topics, java.util.Collection processed)
static java.util.Collection	getOccurrenceTypesFor(Topic topic) Gets all occurrence types that can be used with the specified topic.
static Topic	getRoleClass(Topic role) Gets the content type topic each topic should be an instance of when they are in the specified role in an association.
static java.util.Collection	getSubClassesOf(Topic topic) Gets sub classes of a topic using the standard topics for association type and role topics.
static java.util.Collection	getSubClassesOf(Topic topic, java.lang.String subSI, java.lang.String assocSI, java.lang.String superSI) Gets sub classes of a topic using custom topics for association type and role topics in the association.
static java.util.Collection	getSuperClassesOf(Topic topic) Gets super classes of a topic using the standard topics for association type and role topics.
static java.util.Collection	getSuperClassesOf(Topic topic, java.lang.String subSI, java.lang.String assocSI, java.lang.String superSI) Gets super classes of a topic using custom topics for association type and role topics in the association.
static java.util.Collection	getSuperClassesOfRecursive(Topic topic) Recursively gets all super classes of a topic using the standard association type and association roles.
private static void	getSuperClassesOfRecursive(Topic topic, java.util.HashSet processed, java.util.HashSet classes)
static boolean	isInstanceOf(Topic topic, Topic cls) Checks if a topic is instance of the specified class in the schema.
private static boolean	isInstanceOf(Topic topic, Topic cls, java.util.Collection processed)
static void	setSuperClass(Topic subclass, Topic superclass) Creates a new superclass-subclass association with the specified topics as the sub class and the super class.

Methods inherited from class java.lang.Object

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

Field Detail

ROLECLASS_SI

public static final java.lang.String ROLECLASS_SI

See Also:

Constant Field Values

CONTENTTYPE_SI

public static final java.lang.String CONTENTTYPE_SI

See Also:

Constant Field Values

ASSOCIATIONTYPE_SI

public static final java.lang.String ASSOCIATIONTYPE_SI

See Also:

Constant Field Values

OCCURRENCETYPE_SI

public static final java.lang.String OCCURRENCETYPE_SI

See Also:

Constant Field Values

ROLE_SI

public static final java.lang.String ROLE_SI

See Also:

Constant Field Values

DEFAULT_OCCURRENCE_SI

public static final java.lang.String DEFAULT_OCCURRENCE_SI

See Also:

Constant Field Values

DEFAULT_ASSOCIATION_SI

public static final java.lang.String DEFAULT_ASSOCIATION_SI

See Also:

Constant Field Values

DEFAULT_ROLE_1_SI

public static final java.lang.String DEFAULT_ROLE_1_SI

See Also:

Constant Field Values

DEFAULT_ROLE_2_SI

public static final java.lang.String DEFAULT_ROLE_2_SI

See Also:

Constant Field Values

ANY_SI

public static final java.lang.String ANY_SI

See Also:

Constant Field Values

COUNT_SINGLE

public static final int COUNT_SINGLE

See Also:

Constant Field Values

COUNT_ATMOSTONE

public static final int COUNT_ATMOSTONE

See Also:

Constant Field Values

COUNT_ATLEASTONE

public static final int COUNT_ATLEASTONE

See Also:

Constant Field Values

COUNT_MULTIPLE

public static final int COUNT_MULTIPLE

See Also:

Constant Field Values

Constructor Detail

SchemaBox

public SchemaBox()

Creates a new instance of SchemaBox

Method Detail

isInstanceOf

public static boolean isInstanceOf(Topic topic,
                                   Topic cls)
                            throws TopicMapException

Checks if a topic is instance of the specified class in the schema. The Topic doesn't have to be a direct instance of the class for this method to return true. It can be an instance of some other class that is a subclass of the specified class or a subclass of a subclass of the specified class etc.

Throws:

TopicMapException

isInstanceOf

private static boolean isInstanceOf(Topic topic,
                                    Topic cls,
                                    java.util.Collection processed)
                             throws TopicMapException

Throws:

TopicMapException

getInstancesOf

public static java.util.Collection getInstancesOf(Topic topic)
                                           throws TopicMapException

Gets all instances of a class topic. Here instances doesn't mean only direct instances but also instances of all subclasses, instances of their subclasses etc.

Throws:

TopicMapException

getInstancesOf

private static void getInstancesOf(Topic topic,
                                   java.util.Collection topics,
                                   java.util.Collection processed)
                            throws TopicMapException

Throws:

TopicMapException

getRoleClass

public static Topic getRoleClass(Topic role)
                          throws TopicMapException

Gets the content type topic each topic should be an instance of when they are in the specified role in an association. The schema may specify a content type for each role with an association. If such an association doesn't exist then the role itself is returned and topics with this role in an association should be instances of the role topic itself.

Throws:

TopicMapException

getSubClassesOf

public static java.util.Collection getSubClassesOf(Topic topic)
                                            throws TopicMapException

Gets sub classes of a topic using the standard topics for association type and role topics. Only gets direct sub classes of the topic.

Throws:

TopicMapException

getSubClassesOf

public static java.util.Collection getSubClassesOf(Topic topic,
                                                   java.lang.String subSI,
                                                   java.lang.String assocSI,
                                                   java.lang.String superSI)
                                            throws TopicMapException

Gets sub classes of a topic using custom topics for association type and role topics in the association. You need to give a topic for the association type, the role topic for the sub class and the role topic for the super class. Only gets direct subclasses of the topic.

Throws:

TopicMapException

getSuperClassesOf

public static java.util.Collection getSuperClassesOf(Topic topic)
                                              throws TopicMapException

Gets super classes of a topic using the standard topics for association type and role topics. Only gets direct superclasses of the topic.

Throws:

TopicMapException

getSuperClassesOf

public static java.util.Collection getSuperClassesOf(Topic topic,
                                                     java.lang.String subSI,
                                                     java.lang.String assocSI,
                                                     java.lang.String superSI)
                                              throws TopicMapException

Gets super classes of a topic using custom topics for association type and role topics in the association. You need to give a topic for the association type, the role topic for the sub class and the role topic for the super class. Only gets direct superclasses of the topic.

Throws:

TopicMapException

getSuperClassesOfRecursive

public static java.util.Collection getSuperClassesOfRecursive(Topic topic)
                                                       throws TopicMapException

Recursively gets all super classes of a topic using the standard association type and association roles. That is gets direct super classes of the topic and all their super classes etc.

Throws:

TopicMapException

getSuperClassesOfRecursive

private static void getSuperClassesOfRecursive(Topic topic,
                                               java.util.HashSet processed,
                                               java.util.HashSet classes)
                                        throws TopicMapException

Throws:

TopicMapException

getContentTypesOf

public static java.util.Collection getContentTypesOf(Topic topic)
                                              throws TopicMapException

Gets all content types of this class is an instance of. Instance of here means that the topic is either a direct instance of the class or it is an instance of a class that is a subclass (possibly through many associations) of the content type.

Throws:

TopicMapException

getContentTypesOfNoSupers

private static void getContentTypesOfNoSupers(Topic topic,
                                              java.util.Collection processed,
                                              java.util.Collection types,
                                              Topic contenttype)
                                       throws TopicMapException

Throws:

TopicMapException

getAssociationTypesFor

public static java.util.Collection getAssociationTypesFor(Topic topic)
                                                   throws TopicMapException

Gets all association types that can be used with the specified topic. Possible association types are specified in the content type topics. This method collects all such association types from all content types of the specified topic. Content types of the topic are resolved with getContentTypesOf.

Throws:

TopicMapException

getOccurrenceTypesFor

public static java.util.Collection getOccurrenceTypesFor(Topic topic)
                                                  throws TopicMapException

Gets all occurrence types that can be used with the specified topic. Possible occurrence types are specified in the content type topics. This method collects all such occurrence types from all content types of the specified topic. Content types of the topic are resolved with getContentTypesOf.

Throws:

TopicMapException

setSuperClass

public static void setSuperClass(Topic subclass,
                                 Topic superclass)
                          throws TopicMapException

Creates a new superclass-subclass association with the specified topics as the sub class and the super class.

Throws:

TopicMapException

getAssociationTypeRoles

public static java.util.Collection getAssociationTypeRoles(Topic associationType)
                                                    throws TopicMapException

Gets all roles that can be used with the specified association type. Each association type topic specifies all roles that can (and should) be used whit associations of that type. This method gets those roles.

Throws:

TopicMapException