org.ceryle.tm
Interface aspect

All Known Implementing Classes:

aspectImpl

public interface aspect

NOTE: I created this from Murray's by replacing all "facet" with "aspect", then "aspected" with "described".

An interface for a structure containing a Topic Map aspect, including its type, value, default value, and constraining aspects.

This interface relies on the PSIs defined by the aspects.xtm Topic Map:

   publicId: "-//purl.org/ceryle//DOCUMENT aspects for XTM 1.0//EN"
   systemId: "http://purl.org/ceryle/psi/aspects/aspects.xtm" 

which defines the Topics:

Topic	PSI	type/notes
aspects	http://purl.org/ceryle/psi/aspects/#aspects	Topic: PSI class
hasaspect	http://purl.org/ceryle/psi/aspects/#hasaspect	Topic: predicate
aspect	http://purl.org/ceryle/psi/aspects/#aspect	Topic: role
described	http://purl.org/ceryle/psi/aspects/#described	Topic: role
aspectType	http://purl.org/ceryle/psi/aspects/#aspectType	Topic: type
aspectName	http://purl.org/ceryle/psi/aspects/#aspectName	BaseName: string value or ref
aspectValue	http://purl.org/ceryle/psi/aspects/#aspectValue	Occurrence: string value or ref
aspectDefault	http://purl.org/ceryle/psi/aspects/#aspectDefault	Occurrence: string value or ref
aspectMinIncl	http://purl.org/ceryle/psi/aspects/#aspectMinIncl	Occurrence: string value or ref
aspectMaxIncl	http://purl.org/ceryle/psi/aspects/#aspectMaxIncl	Occurrence: string value or ref
aspectMinExcl	http://purl.org/ceryle/psi/aspects/#aspectMinExcl	Occurrence: string value or ref
aspectMaxExcl	http://purl.org/ceryle/psi/aspects/#aspectMaxExcl	Occurrence: string value or ref

Note that there is no setdescribed(Topic) or setaspect(Topic) method, as these required Topics is set via the constructor. Also, this interface does not currently support enumerations - this is planned for a later version.

Copyright 2003 Murray Altheim. All Rights Reserved.

Permission to use, copy, modify and distribute this interface and its accompanying documentation for any purpose and without fee is hereby granted in perpetuity, provided that the above copyright notice and this paragraph appear in all copies. The copyright holders make no representation about the suitability of the interface for any purpose. It is provided "as is" without expressed or implied warranty.

Since:

JDK1.4

Version:

$Id: aspect.java,v 1.1 2003/11/26 05:40:48 altheim Exp $

Author:

Murray Altheim

See Also:

aspectImpl

Method Summary

org.tm4j.topicmap.Topic	getaspect() Return the aspect Topic.
org.tm4j.topicmap.Occurrence	getaspectDefault() Return the aspect Default as a Topic Occurrence.
org.tm4j.topicmap.Topic	getdescribed() Return the described Topic.
org.tm4j.topicmap.Association	getaspectLink() Return the aspect Association.
org.tm4j.topicmap.Occurrence	getaspectMaxExcl() Return the aspect maximum exclusive constraint as a Topic Occurrence.
org.tm4j.topicmap.Occurrence	getaspectMaxIncl() Return the aspect maximum inclusive constraint as a Topic Occurrence.
org.tm4j.topicmap.Occurrence	getaspectMinExcl() Return the aspect minimum exclusive constraint as a Topic Occurrence.
org.tm4j.topicmap.Occurrence	getaspectMinIncl() Return the aspect minimum inclusive constraint as a Topic Occurrence.
org.tm4j.topicmap.BaseName	getaspectName() Return the aspect Name as a String.
java.util.Collection	getaspectTypes(boolean includeMergedTopics) Return the types of this aspect, and optionally, of all merged Topics.
org.tm4j.topicmap.Occurrence	getaspectValue() Return the aspect value as an Occurrence.
void	setaspectDefault(java.lang.Object aspectDefault) Set the aspect default value to the object aspectDefault, which must be either a String or a Locator.
void	setaspectMaxExcl(java.lang.Object aspectMaxExcl) Set the aspect maximum exclusive constraint to the Object aspectMaxExcl, which must be either a String or a Locator.
void	setaspectMaxIncl(java.lang.Object aspectMaxIncl) Set the aspect maximum inclusive constraint to the Object aspectMaxIncl, which must be either a String or a Locator.
void	setaspectMinExcl(java.lang.Object aspectMinExcl) Set the aspect minimum exclusive constraint to the Object aspectMinExcl, which must be either a String or a Locator.
void	setaspectMinIncl(java.lang.Object aspectMinIncl) Set the aspect minimum inclusive constraint to the Object aspectMinIncl, which must be either a String or a Locator.
void	setaspectName(java.lang.String aspectName) Set the aspect Name to the String aspectName.
void	setaspectType(org.tm4j.topicmap.Topic aspectType) Add the Topic aspectType as a type of this aspect.
void	setaspectValue(java.lang.Object aspectValue) Set the aspect Value to the Object aspectValue, which must be either a String or a Locator.

Method Detail

getdescribed

public org.tm4j.topicmap.Topic getdescribed()

Return the described Topic.

getaspect

public org.tm4j.topicmap.Topic getaspect()

Return the aspect Topic.

getaspectLink

public org.tm4j.topicmap.Association getaspectLink()

Return the aspect Association.

setaspectType

public void setaspectType(org.tm4j.topicmap.Topic aspectType)
                  throws TopicMapException

Add the Topic aspectType as a type of this aspect.

TopicMapException

getaspectTypes

public java.util.Collection getaspectTypes(boolean includeMergedTopics)

Return the types of this aspect, and optionally, of all merged Topics.

setaspectValue

public void setaspectValue(java.lang.Object aspectValue)
                   throws TopicMapException

Set the aspect Value to the Object aspectValue, which must be either a String or a Locator. This will overwrite any existing value.

TopicMapException

getaspectValue

public org.tm4j.topicmap.Occurrence getaspectValue()

Return the aspect value as an Occurrence.

setaspectName

public void setaspectName(java.lang.String aspectName)
                  throws TopicMapException

Set the aspect Name to the String aspectName.

TopicMapException

getaspectName

public org.tm4j.topicmap.BaseName getaspectName()

Return the aspect Name as a String.

setaspectDefault

public void setaspectDefault(java.lang.Object aspectDefault)
                     throws TopicMapException

Set the aspect default value to the object aspectDefault, which must be either a String or a Locator.

TopicMapException

getaspectDefault

public org.tm4j.topicmap.Occurrence getaspectDefault()

Return the aspect Default as a Topic Occurrence.

setaspectMinIncl

public void setaspectMinIncl(java.lang.Object aspectMinIncl)
                     throws TopicMapException

Set the aspect minimum inclusive constraint to the Object aspectMinIncl, which must be either a String or a Locator.

TopicMapException

getaspectMinIncl

public org.tm4j.topicmap.Occurrence getaspectMinIncl()

Return the aspect minimum inclusive constraint as a Topic Occurrence.

setaspectMaxIncl

public void setaspectMaxIncl(java.lang.Object aspectMaxIncl)
                     throws TopicMapException

Set the aspect maximum inclusive constraint to the Object aspectMaxIncl, which must be either a String or a Locator.

TopicMapException

getaspectMaxIncl

public org.tm4j.topicmap.Occurrence getaspectMaxIncl()

Return the aspect maximum inclusive constraint as a Topic Occurrence.

setaspectMinExcl

public void setaspectMinExcl(java.lang.Object aspectMinExcl)
                     throws TopicMapException

Set the aspect minimum exclusive constraint to the Object aspectMinExcl, which must be either a String or a Locator.

TopicMapException

getaspectMinExcl

public org.tm4j.topicmap.Occurrence getaspectMinExcl()

Return the aspect minimum exclusive constraint as a Topic Occurrence.

setaspectMaxExcl

public void setaspectMaxExcl(java.lang.Object aspectMaxExcl)
                     throws TopicMapException

Set the aspect maximum exclusive constraint to the Object aspectMaxExcl, which must be either a String or a Locator.

TopicMapException

getaspectMaxExcl

public org.tm4j.topicmap.Occurrence getaspectMaxExcl()

Return the aspect maximum exclusive constraint as a Topic Occurrence.