From: <lh...@us...> - 2008-08-08 12:00:46
|
Revision: 62 http://tmapi.svn.sourceforge.net/tmapi/?rev=62&view=rev Author: lheuer Date: 2008-08-08 12:00:50 +0000 (Fri, 08 Aug 2008) Log Message: ----------- - Docs for the exceptions - Minor doc tweaks (<p/>'s etc) Modified Paths: -------------- trunk/src/main/java/org/tmapi/core/Association.java trunk/src/main/java/org/tmapi/core/Construct.java trunk/src/main/java/org/tmapi/core/DatatypeAware.java trunk/src/main/java/org/tmapi/core/FactoryConfigurationException.java trunk/src/main/java/org/tmapi/core/FeatureNotRecognizedException.java trunk/src/main/java/org/tmapi/core/FeatureNotSupportedException.java trunk/src/main/java/org/tmapi/core/IdentityConstraintException.java trunk/src/main/java/org/tmapi/core/Locator.java trunk/src/main/java/org/tmapi/core/ModelConstraintException.java trunk/src/main/java/org/tmapi/core/Name.java trunk/src/main/java/org/tmapi/core/Occurrence.java trunk/src/main/java/org/tmapi/core/Reifiable.java trunk/src/main/java/org/tmapi/core/Role.java trunk/src/main/java/org/tmapi/core/Scoped.java trunk/src/main/java/org/tmapi/core/TMAPIException.java trunk/src/main/java/org/tmapi/core/TMAPIRuntimeException.java trunk/src/main/java/org/tmapi/core/Topic.java trunk/src/main/java/org/tmapi/core/TopicInUseException.java trunk/src/main/java/org/tmapi/core/TopicMap.java trunk/src/main/java/org/tmapi/core/TopicMapExistsException.java trunk/src/main/java/org/tmapi/core/TopicMapSystem.java trunk/src/main/java/org/tmapi/core/TopicMapSystemFactory.java trunk/src/main/java/org/tmapi/core/Typed.java trunk/src/main/java/org/tmapi/core/Variant.java trunk/src/main/java/org/tmapi/index/Index.java trunk/src/main/java/org/tmapi/index/LiteralIndex.java trunk/src/main/java/org/tmapi/index/ScopedIndex.java trunk/src/main/java/org/tmapi/index/TypeInstanceIndex.java trunk/src/test/java/org/tmapi/core/AllCoreTests.java trunk/src/test/java/org/tmapi/core/TMAPITestCase.java trunk/src/test/java/org/tmapi/core/TestAssociation.java trunk/src/test/java/org/tmapi/core/TestConstruct.java trunk/src/test/java/org/tmapi/core/TestDatatypeAware.java trunk/src/test/java/org/tmapi/core/TestLocator.java trunk/src/test/java/org/tmapi/core/TestName.java trunk/src/test/java/org/tmapi/core/TestOccurrence.java trunk/src/test/java/org/tmapi/core/TestReified.java trunk/src/test/java/org/tmapi/core/TestRole.java trunk/src/test/java/org/tmapi/core/TestScoped.java trunk/src/test/java/org/tmapi/core/TestTopic.java trunk/src/test/java/org/tmapi/core/TestTopicMap.java trunk/src/test/java/org/tmapi/core/TestTopicMapMerge.java trunk/src/test/java/org/tmapi/core/TestTopicMapSystem.java trunk/src/test/java/org/tmapi/core/TestTopicMerge.java trunk/src/test/java/org/tmapi/core/TestTopicMergeDetection.java trunk/src/test/java/org/tmapi/core/TestTyped.java trunk/src/test/java/org/tmapi/core/TestVariant.java trunk/src/test/java/org/tmapi/index/AllIndexTests.java trunk/src/test/java/org/tmapi/index/TestLiteralIndex.java trunk/src/test/java/org/tmapi/index/TestScopedIndex.java trunk/src/test/java/org/tmapi/index/TestTypeInstanceIndex.java Modified: trunk/src/main/java/org/tmapi/core/Association.java =================================================================== --- trunk/src/main/java/org/tmapi/core/Association.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/Association.java 2008-08-08 12:00:50 UTC (rev 62) @@ -19,7 +19,7 @@ * Represents an * <a href="http://www.isotopicmaps.org/sam/sam-model/#sect-association">association item</a>. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public interface Association extends Reifiable, Typed, Scoped { @@ -44,7 +44,7 @@ /** * Returns the role types participating in this association. - * + * <p> * This method returns the same result as the following code: * <pre> * Set<Topic> types = new HashSet<Topic>(); @@ -52,7 +52,7 @@ * types.add(role.getType()); * } * </pre> - * + * </p> * The return value may be empty but must never be <tt>null</tt>. * * @return An unmodifiable set of role types. @@ -61,7 +61,7 @@ /** * Returns all roles with the specified <tt>type</tt>. - * + * <p> * This method returns the same result as the following code: * <pre> * Set<Role> roles = new HashSet<Role>(); @@ -71,7 +71,7 @@ * } * } * </pre> - * + * </p> * The return value may be empty but must never be <tt>null</tt>. * * @param type The type of the {@link Role} instances to be returned, Modified: trunk/src/main/java/org/tmapi/core/Construct.java =================================================================== --- trunk/src/main/java/org/tmapi/core/Construct.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/Construct.java 2008-08-08 12:00:50 UTC (rev 62) @@ -18,7 +18,7 @@ /** * Base interface for all Topic Maps constructs. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public interface Construct { Modified: trunk/src/main/java/org/tmapi/core/DatatypeAware.java =================================================================== --- trunk/src/main/java/org/tmapi/core/DatatypeAware.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/DatatypeAware.java 2008-08-08 12:00:50 UTC (rev 62) @@ -18,12 +18,13 @@ /** * Common base interface for {@link Occurrence}s and {@link Variant}s. - * + * <p> * Some convenience methods for a subset of * <a href="http://www.w3.org/TR/xmlschema-2/">XML Schema Part 2: Datatypes</a> * are supported. + * </p> * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public interface DatatypeAware extends Reifiable, Scoped { @@ -38,12 +39,13 @@ /** * Returns the lexical representation of the value. - * + * <p> * For the datatype <a href="http://www.w3.org/TR/xmlschema-2/#string">xsd:string</a> * the string itself is returned. For the datatype * <a href="http://www.w3.org/TR/xmlschema-2/#anyURI">xsd:anyURI</a> * the {@link Locator#getReference()} is returned. - * + * </p> + * * @return The lexical representation of the value (never <tt>null</tt>). */ public String getValue(); @@ -60,10 +62,11 @@ /** * Sets the IRI value. - * + * <p> * This method sets the datatype implicitly to * <a href="http://www.w3.org/TR/xmlschema-2/#anyURI">xsd:anyURI</a>. - * + * </p> + * * @param value The IRI value. */ public void setValue(Locator value); @@ -78,50 +81,55 @@ /** * Sets the decimal value. - * + * <p> * This method sets the datatype implicitly to * <a href="http://www.w3.org/TR/xmlschema-2/#decimal">xsd:decimal</a>. - * + * </p> + * * @param value The decimal value. */ public void setValue(BigDecimal value); /** * Sets the integer value. - * + * <p> * This method sets the datatype implicitly to * <a href="http://www.w3.org/TR/xmlschema-2/#integer">xsd:integer</a>. - * + * </p> + * * @param value The integer value. */ public void setValue(BigInteger value); /** * Sets the long value. - * + * <p> * This method sets the datatype implicitly to * <a href="http://www.w3.org/TR/xmlschema-2/#long">xsd:long</a>. - * + * </p> + * * @param value The integer value. */ public void setValue(long value); /** * Sets the float value. - * + * <p> * This method sets the datatype implicitly to * <a href="http://www.w3.org/TR/xmlschema-2/#float">xsd:float</a>. - * + * </p> + * * @param value The float value. */ public void setValue(float value); /** * Sets the int value. - * + * <p> * This method sets the datatype implicitly to * <a href="http://www.w3.org/TR/xmlschema-2/#int">xsd:int</a>. - * + * </p> + * * @param value The int value. */ public void setValue(int value); Modified: trunk/src/main/java/org/tmapi/core/FactoryConfigurationException.java =================================================================== --- trunk/src/main/java/org/tmapi/core/FactoryConfigurationException.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/FactoryConfigurationException.java 2008-08-08 12:00:50 UTC (rev 62) @@ -18,42 +18,45 @@ * cannot be instantiated through the method * {@link TopicMapSystemFactory#newInstance()}. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public class FactoryConfigurationException extends TMAPIException { - /** - * - */ private static final long serialVersionUID = -6197383571197389854L; /** - * + * Constructs a new throwable with the specified detail message. * - * @param msg + * @param message The detail message. This message is saved for later + * retrieval by the {@link #getMessage()} method. */ - public FactoryConfigurationException(String msg) { - super(msg); + public FactoryConfigurationException(String message) { + super(message); } /** - * + * Constructs a new exception that wraps another exception. * - * @param cause + * @param cause The throwable which caused this exception to be thrown. + * This value is saved for later retrieval by the + * {@link #getCause()} method. */ public FactoryConfigurationException(Throwable cause) { super(cause); } /** - * + * Constructs a new throwable with the specified detail message. * - * @param msg - * @param cause + * @param message The detail message. This message is saved for later + * retrieval by the {@link #getMessage()} method. + * @param cause The throwable which caused this exception to be thrown. + * This value is saved for later retrieval by the + * {@link #getCause()} method. */ - public FactoryConfigurationException(String msg, Throwable cause) { - super(msg, cause); + public FactoryConfigurationException(String message, Throwable cause) { + super(message, cause); } } Modified: trunk/src/main/java/org/tmapi/core/FeatureNotRecognizedException.java =================================================================== --- trunk/src/main/java/org/tmapi/core/FeatureNotRecognizedException.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/FeatureNotRecognizedException.java 2008-08-08 12:00:50 UTC (rev 62) @@ -13,47 +13,49 @@ */ package org.tmapi.core; - /** * Exception thrown when the TopicMapSystemFactory does not recognize * the name of a feature that the application is trying to enable or disable. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public class FeatureNotRecognizedException extends FactoryConfigurationException { - /** - * - */ private static final long serialVersionUID = 6231608065963599726L; /** - * + * Constructs a new throwable with the specified detail message. * - * @param msg + * @param message The detail message. This message is saved for later + * retrieval by the {@link #getMessage()} method. */ - public FeatureNotRecognizedException(String msg) { - super(msg); + public FeatureNotRecognizedException(String message) { + super(message); } /** - * + * Constructs a new exception that wraps another exception. * - * @param cause + * @param cause The throwable which caused this exception to be thrown. + * This value is saved for later retrieval by the + * {@link #getCause()} method. */ public FeatureNotRecognizedException(Throwable cause) { super(cause); } /** - * + * Constructs a new throwable with the specified detail message. * - * @param msg - * @param cause + * @param message The detail message. This message is saved for later + * retrieval by the {@link #getMessage()} method. + * @param cause The throwable which caused this exception to be thrown. + * This value is saved for later retrieval by the + * {@link #getCause()} method. */ - public FeatureNotRecognizedException(String msg, Throwable cause) { - super(msg, cause); + public FeatureNotRecognizedException(String message, Throwable cause) { + super(message, cause); } } Modified: trunk/src/main/java/org/tmapi/core/FeatureNotSupportedException.java =================================================================== --- trunk/src/main/java/org/tmapi/core/FeatureNotSupportedException.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/FeatureNotSupportedException.java 2008-08-08 12:00:50 UTC (rev 62) @@ -19,26 +19,45 @@ * implementations <strong>MUST</strong> throw a FeatureNotRecognizedException * rather than a FeatureNotSupportedException. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public class FeatureNotSupportedException extends FactoryConfigurationException { + private static final long serialVersionUID = -6901109695537829395L; + /** - * + * Constructs a new throwable with the specified detail message. + * + * @param message The detail message. This message is saved for later + * retrieval by the {@link #getMessage()} method. */ - private static final long serialVersionUID = -6901109695537829395L; - - public FeatureNotSupportedException(String msg) { - super(msg); + public FeatureNotSupportedException(String message) { + super(message); } + /** + * Constructs a new exception that wraps another exception. + * + * @param cause The throwable which caused this exception to be thrown. + * This value is saved for later retrieval by the + * {@link #getCause()} method. + */ public FeatureNotSupportedException(Throwable cause) { super(cause); } - public FeatureNotSupportedException(String msg, Throwable cause) { - super(msg, cause); + /** + * Constructs a new throwable with the specified detail message. + * + * @param message The detail message. This message is saved for later + * retrieval by the {@link #getMessage()} method. + * @param cause The throwable which caused this exception to be thrown. + * This value is saved for later retrieval by the + * {@link #getCause()} method. + */ + public FeatureNotSupportedException(String message, Throwable cause) { + super(message, cause); } } Modified: trunk/src/main/java/org/tmapi/core/IdentityConstraintException.java =================================================================== --- trunk/src/main/java/org/tmapi/core/IdentityConstraintException.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/IdentityConstraintException.java 2008-08-08 12:00:50 UTC (rev 62) @@ -20,12 +20,11 @@ * to different objects causes an <tt>IdentityConstraintException</tt> to be * thrown. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev: 33 $ - $Date: 2008-08-02 16:42:29 +0200 (Sa, 02 Aug 2008) $ */ public class IdentityConstraintException extends ModelConstraintException { - private static final long serialVersionUID = -8239221052536586370L; private final Construct _existing; Modified: trunk/src/main/java/org/tmapi/core/Locator.java =================================================================== --- trunk/src/main/java/org/tmapi/core/Locator.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/Locator.java 2008-08-08 12:00:50 UTC (rev 62) @@ -16,7 +16,7 @@ /** * Immutable representation of an IRI. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public interface Locator { Modified: trunk/src/main/java/org/tmapi/core/ModelConstraintException.java =================================================================== --- trunk/src/main/java/org/tmapi/core/ModelConstraintException.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/ModelConstraintException.java 2008-08-08 12:00:50 UTC (rev 62) @@ -18,7 +18,7 @@ * <a href="http://www.isotopicmaps.org/sam/sam-model/">Topic Maps \x97 Data Model</a> * constraint violations. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev: 33 $ - $Date: 2008-08-02 16:42:29 +0200 (Sa, 02 Aug 2008) $ */ public class ModelConstraintException extends TMAPIRuntimeException { @@ -43,7 +43,7 @@ * Returns the {@link Construct} which has thrown the exception. * * @return The construct which has thrown the exception or <tt>null</tt> - * if no approbiate construct is available (i.e. in the factory + * if no appropiate construct is available (i.e. in the factory * methods). */ public Construct getSender() { Modified: trunk/src/main/java/org/tmapi/core/Name.java =================================================================== --- trunk/src/main/java/org/tmapi/core/Name.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/Name.java 2008-08-08 12:00:50 UTC (rev 62) @@ -20,7 +20,7 @@ * Represents a * <a href="http://www.isotopicmaps.org/sam/sam-model/#sect-topic-name">topic name item</a>. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public interface Name extends Typed, Scoped, Reifiable { @@ -62,10 +62,11 @@ /** * Creates a {@link Variant} of this topic name with the specified string * <tt>value</tt> and <tt>scope</tt>. - * + * <p> * The newly created {@link Variant} will have the datatype * <a href="http://www.w3.org/TR/xmlschema-2/#string">xsd:string</a>. - * + * </p> + * * @param value The string value. * @param scope An array (length >= 1) of themes. * @return The newly created {@link Variant} @@ -77,10 +78,11 @@ /** * Creates a {@link Variant} of this topic name with the specified string * <tt>value</tt> and <tt>scope</tt>. - * + * <p> * The newly created {@link Variant} will have the datatype * <a href="http://www.w3.org/TR/xmlschema-2/#string">xsd:string</a>. - * + * </p> + * * @param value The string value. * @param scope A collection (size >= 1) of themes. * @return The newly created {@link Variant} @@ -92,10 +94,11 @@ /** * Creates a {@link Variant} of this topic name with the specified IRI * <tt>value</tt> and <tt>scope</tt>. - * + * <p> * The newly created {@link Variant} will have the datatype * <a href="http://www.w3.org/TR/xmlschema-2/#anyURI">xsd:anyURI</a>. - * + * </p> + * * @param value A locator which represents an IRI. * @param scope An array (length >= 1) of themes. * @return The newly created {@link Variant} @@ -107,10 +110,11 @@ /** * Creates a {@link Variant} of this topic name with the specified IRI * <tt>value</tt> and <tt>scope</tt>. - * + * <p> * The newly created {@link Variant} will have the datatype * <a href="http://www.w3.org/TR/xmlschema-2/#anyURI">xsd:anyURI</a>. - * + * </p> + * * @param value A locator which represents an IRI. * @param scope A collection (size >= 1) of themes. * @return The newly created {@link Variant} @@ -122,10 +126,11 @@ /** * Creates a {@link Variant} of this topic name with the specified IRI * <tt>value</tt>, <tt>datatype</tt>, and <tt>scope</tt>. - * + * <p> * The newly created {@link Variant} will have the datatype specified by * <tt>datatype</tt>. - * + * </p> + * * @param value A lexical string representation of the value. * @param datatype A locator indicating the datatype of the <tt>value</tt>. * @param scope An array (length >= 1) of themes. @@ -138,10 +143,11 @@ /** * Creates a {@link Variant} of this topic name with the specified IRI * <tt>value</tt>, <tt>datatype</tt>, and <tt>scope</tt>. - * + * <p> * The newly created {@link Variant} will have the datatype specified by * <tt>datatype</tt>. - * + * </p> + * * @param value A lexical string representation of the value. * @param datatype A locator indicating the datatype of the <tt>value</tt>. * @param scope A collection (size >= 1) of themes. Modified: trunk/src/main/java/org/tmapi/core/Occurrence.java =================================================================== --- trunk/src/main/java/org/tmapi/core/Occurrence.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/Occurrence.java 2008-08-08 12:00:50 UTC (rev 62) @@ -17,7 +17,7 @@ * Represents an * <a href="http://www.isotopicmaps.org/sam/sam-model/#sect-occurrence">occurrence item</a>. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public interface Occurrence extends Typed, DatatypeAware { Modified: trunk/src/main/java/org/tmapi/core/Reifiable.java =================================================================== --- trunk/src/main/java/org/tmapi/core/Reifiable.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/Reifiable.java 2008-08-08 12:00:50 UTC (rev 62) @@ -18,7 +18,7 @@ * * Every Topic Maps construct that is not a {@link Topic} is reifiable. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public interface Reifiable extends Construct { Modified: trunk/src/main/java/org/tmapi/core/Role.java =================================================================== --- trunk/src/main/java/org/tmapi/core/Role.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/Role.java 2008-08-08 12:00:50 UTC (rev 62) @@ -17,7 +17,7 @@ * Represents an * <a href="http://www.isotopicmaps.org/sam/sam-model/#sect-assoc-role">association role item</a>. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public interface Role extends Reifiable, Typed { Modified: trunk/src/main/java/org/tmapi/core/Scoped.java =================================================================== --- trunk/src/main/java/org/tmapi/core/Scoped.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/Scoped.java 2008-08-08 12:00:50 UTC (rev 62) @@ -21,7 +21,7 @@ * {@link Association}s, {@link Occurrence}s, {@link Name}s, and * {@link Variant}s are scoped. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public interface Scoped extends Construct { Modified: trunk/src/main/java/org/tmapi/core/TMAPIException.java =================================================================== --- trunk/src/main/java/org/tmapi/core/TMAPIException.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/TMAPIException.java 2008-08-08 12:00:50 UTC (rev 62) @@ -17,47 +17,42 @@ * The base class for all standard (non run-time) exceptions thrown by a * TMAPI system. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public class TMAPIException extends Exception { - /** - * - */ private static final long serialVersionUID = -804738055960757078L; /** - * + * Constructs a new throwable with the specified detail message. * + * @param message The detail message. This message is saved for later + * retrieval by the {@link #getMessage()} method. + * @param cause The throwable which caused this exception to be thrown. + * This value is saved for later retrieval by the + * {@link #getCause()} method. */ - public TMAPIException() { - super(); - } - - /** - * - * - * @param message - * @param cause - */ public TMAPIException(String message, Throwable cause) { super(message, cause); } /** - * + * Constructs a new throwable with the specified detail message. * - * @param message + * @param message The detail message. This message is saved for later + * retrieval by the {@link #getMessage()} method. */ public TMAPIException(String message) { super(message); } /** - * + * Constructs a new exception that wraps another exception. * - * @param cause + * @param cause The throwable which caused this exception to be thrown. + * This value is saved for later retrieval by the + * {@link #getCause()} method. */ public TMAPIException(Throwable cause) { super(cause); Modified: trunk/src/main/java/org/tmapi/core/TMAPIRuntimeException.java =================================================================== --- trunk/src/main/java/org/tmapi/core/TMAPIRuntimeException.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/TMAPIRuntimeException.java 2008-08-08 12:00:50 UTC (rev 62) @@ -18,39 +18,42 @@ * is an error in the underlying topic map processing system or when integrity * constraints are violated. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev:$ - $Date:$ */ public class TMAPIRuntimeException extends RuntimeException { - /** - * - */ private static final long serialVersionUID = -5272967154641022529L; /** - * - * - * @param msg - * @param cause + * Constructs a new throwable with the specified detail message. + * + * @param message The detail message. This message is saved for later + * retrieval by the {@link #getMessage()} method. + * @param cause The throwable which caused this exception to be thrown. + * This value is saved for later retrieval by the + * {@link #getCause()} method. */ - public TMAPIRuntimeException(String msg, Throwable cause) { - super(msg, cause); + public TMAPIRuntimeException(String message, Throwable cause) { + super(message, cause); } /** - * - * - * @param msg + * Constructs a new throwable with the specified detail message. + * + * @param message The detail message. This message is saved for later + * retrieval by the {@link #getMessage()} method. */ - public TMAPIRuntimeException(String msg) { - super(msg); + public TMAPIRuntimeException(String message) { + super(message); } /** - * - * - * @param cause + * Constructs a new exception that wraps another exception. + * + * @param cause The throwable which caused this exception to be thrown. + * This value is saved for later retrieval by the + * {@link #getCause()} method. */ public TMAPIRuntimeException(Throwable cause) { super(cause); Modified: trunk/src/main/java/org/tmapi/core/Topic.java =================================================================== --- trunk/src/main/java/org/tmapi/core/Topic.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/Topic.java 2008-08-08 12:00:50 UTC (rev 62) @@ -20,7 +20,7 @@ * Represents a * <a href="http://www.isotopicmaps.org/sam/sam-model/#d0e739">topic item</a>. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public interface Topic extends Construct { @@ -36,11 +36,12 @@ /** * Adds an item identifier to this topic. - * + * <p> * If adding the specified item identifier would make this topic * represent the same subject as another topic and the feature * "automerge" (http://tmapi.org/features/automerge) is disabled, * an {@link IdentityConstraintException} is thrown. + * </p> * * @see org.tmapi.core.Construct#addItemIdentifier(org.tmapi.core.Locator) */ @@ -58,12 +59,13 @@ /** * Adds a subject identifier to this topic. - * + * <p> * If adding the specified subject identifier would make this topic * represent the same subject as another topic and the feature * "automerge" (http://tmapi.org/features/automerge/) is disabled, * an {@link IdentityConstraintException} is thrown. - * + * </p> + * * @param sid The subject identifier to be added; must not be <tt>null</tt>. * @throws IdentityConstraintException If the feature "automerge" is * disabled and adding the subject identifier would make this @@ -90,12 +92,13 @@ /** * Adds a subject locator to this topic. - * + * <p> * If adding the specified subject locator would make this topic * represent the same subject as another topic and the feature * "automerge" (http://tmapi.org/features/automerge/) is disabled, * an {@link IdentityConstraintException} is thrown. - * + * </p> + * * @param slo The subject locator to be added; must not be <tt>null</tt>. * @throws IdentityConstraintException If the feature "automerge" is * disabled and adding the subject locator would make this @@ -122,7 +125,7 @@ /** * Returns the {@link Name}s of this topic where the name type is * <tt>type</tt>. - * + * <p> * This method returns the same result as the following code: * <pre> * Set<Name> names = new HashSet<Name>(); @@ -132,7 +135,7 @@ * } * } * </pre> - * + * </p> * The return value may be empty but must never be <tt>null</tt>. * * @param type The type of the {@link Name}s to be returned; @@ -170,11 +173,12 @@ /** * Creates a {@link Name} for this topic with the specified <tt>value</tt>, * and <tt>scope</tt>. - * + * <p> * The created {@link Name} will have the default name type * (a {@link Topic} with the subject identifier * <a href="http://psi.topicmaps.org/iso13250/model/topic-name">http://psi.topicmaps.org/iso13250/model/topic-name</a>). - * + * </p> + * * @param value The string value of the name; MUST NOT be <tt>null</tt>. * @param scope An optional array of themes, must not be <tt>null</tt>. If * the array's length is <tt>0</tt>, the name will be @@ -186,11 +190,12 @@ /** * Creates a {@link Name} for this topic with the specified <tt>value</tt>, * and <tt>scope</tt>. - * + * <p> * The created {@link Name} will have the default name type * (a {@link Topic} with the subject identifier * <a href="http://psi.topicmaps.org/iso13250/model/topic-name">http://psi.topicmaps.org/iso13250/model/topic-name</a>). - * + * </p> + * * @param value The string value of the name; MUST NOT be <tt>null</tt>. * @param scope A collection of themes or <tt>null</tt> if the name should * be in the unconstrained scope. @@ -210,7 +215,7 @@ /** * Returns the {@link Occurrence}s of this topic where the occurrence type * is <tt>type</tt>. - * + * <p> * This method returns the same result as the following code: * <pre> * Set<Occurrence> occs = new HashSet<Occurrence>(); @@ -220,7 +225,7 @@ * } * } * </pre> - * + * </p> * The return value may be empty but must never be <tt>null</tt>. * * @param type The type of the {@link Occurrence}s to be returned; @@ -233,10 +238,11 @@ /** * Creates an {@link Occurrence} for this topic with the specified * <tt>type</tt>, string <tt>value</tt>, and <tt>scope</tt>. - * + * <p> * The newly created {@link Occurrence} will have the datatype * <a href="http://www.w3.org/TR/xmlschema-2/#string">xsd:string</a>. - * + * </p> + * * @param type The occurrence type; MUST NOT be <tt>null</tt>. * @param value The string value of the occurrence. * @param scope An optional array of themes, must not be <tt>null</tt>. If @@ -249,10 +255,11 @@ /** * Creates an {@link Occurrence} for this topic with the specified * <tt>type</tt>, string <tt>value</tt>, and <tt>scope</tt>. - * + * <p> * The newly created {@link Occurrence} will have the datatype * <a href="http://www.w3.org/TR/xmlschema-2/#string">xsd:string</a>. - * + * </p> + * * @param type The occurrence type; MUST NOT be <tt>null</tt>. * @param value The string value of the occurrence. * @param scope A collection of themes or <tt>null</tt> if the occurrence @@ -265,10 +272,11 @@ /** * Creates an {@link Occurrence} for this topic with the specified * <tt>type</tt>, IRI <tt>value</tt>, and <tt>scope</tt>. - * + * <p> * The newly created {@link Occurrence} will have the datatype * <a href="http://www.w3.org/TR/xmlschema-2/#anyURI">xsd:anyURI</a>. - * + * </p> + * * @param type The occurrence type; MUST NOT be <tt>null</tt>. * @param value A locator which represents an IRI. * @param scope An optional array of themes, must not be <tt>null</tt>. If @@ -282,10 +290,11 @@ /** * Creates an {@link Occurrence} for this topic with the specified * <tt>type</tt>, IRI <tt>value</tt>, and <tt>scope</tt>. - * + * <p> * The newly created {@link Occurrence} will have the datatype * <a href="http://www.w3.org/TR/xmlschema-2/#anyURI">xsd:anyURI</a>. - * + * </p> + * * @param type The occurrence type; MUST NOT be <tt>null</tt>. * @param value A locator which represents an IRI. * @param scope A collection of themes or <tt>null</tt> if the occurrence @@ -298,10 +307,11 @@ /** * Creates an {@link Occurrence} for this topic with the specified * <tt>type</tt>, <tt>value</tt>, <tt>datatype</tt>, and <tt>scope</tt>. - * + * <p> * The newly created {@link Occurrence} will have the datatype specified * by <tt>datatype</tt>. - * + * </p> + * * @param type The occurrence type; MUST NOT be <tt>null</tt>. * @param value A lexical string representation of the value. * @param datatype A locator indicating the datatype of the <tt>value</tt>. @@ -316,10 +326,11 @@ /** * Creates an {@link Occurrence} for this topic with the specified * <tt>type</tt>, <tt>value</tt>, <tt>datatype</tt>, and <tt>scope</tt>. - * + * <p> * The newly created {@link Occurrence} will have the datatype specified * by <tt>datatype</tt>. - * + * </p> + * * @param type The occurrence type; MUST NOT be <tt>null</tt>. * @param value A lexical string representation of the value. * @param datatype A locator indicating the datatype of the <tt>value</tt>. @@ -342,7 +353,7 @@ /** * Returns the roles played by this topic where the role type is * <tt>type</tt>. - * + * <p> * This method returns the same result as the following code: * <pre> * Set<Role> roles = new HashSet<Role>(); @@ -352,6 +363,7 @@ * } * } * </pre> + * </p> * * The return value may be empty but must never be <tt>null</tt>. * @@ -364,7 +376,7 @@ /** * Returns the {@link Role}s played by this topic where the role type is * <tt>type</tt> and the {@link Association} type is <tt>assocType</tt>. - * + * <p> * This method returns the same result as the following code: * <pre> * Set<Role> roles = new HashSet<Role>(); @@ -374,7 +386,7 @@ * } * } * </pre> - * + * </p> * The return value may be empty but must never be <tt>null</tt>. * * @param type The type of the {@link Role}s to be returned; @@ -389,12 +401,12 @@ /** * Returns the types of which this topic is an instance of. - * + * <p> * This method may return only those types which where added by * {@link #addType(Topic)} and may ignore * <a href="http://www.isotopicmaps.org/sam/sam-model/#sect-types">type-instance</a> * relationships which are modelled as association. - * + * </p> * The return value may be empty but must never be <tt>null</tt>. * * @return An unmodifiable set of {@link Topic}s. @@ -403,11 +415,12 @@ /** * Adds a type to this topic. - * + * <p> * Implementations may or may not create an association for types added * by this method. In any case, every type which was added by this method * must be returned by the {@link #getTypes()} method. - * + * </p> + * * @param type The type of which this topic should become an instance of; * must not be <tt>null</tt>. */ @@ -430,26 +443,30 @@ /** * Merges another topic into this topic. - * + * <p> * Merging a topic into this topic causes this topic to gain all * of the characteristics of the other topic and to replace the other * topic wherever it is used as type, theme, or reifier. * After this method completes, <tt>other</tt> will have been removed from - * the {@link TopicMap}. + * the {@link TopicMap}. + * </p> + * <p> * NOTE: The other topic MUST belong to the same {@link TopicMap} instance * as this topic! - * + * </p> + * * @param other The topic to be merged into this topic. */ public void mergeIn(Topic other); /** * Removes this topic from the containing {@link TopicMap} instance. - * + * <p> * This method throws a {@link TopicInUseException} if the topic plays * a {@link Role}, is used as type of a {@link Typed} construct, or if * it is used as theme for a {@link Scoped} construct, or if it reifies a * {@link Reifiable}. + * </p> * * @see org.tmapi.core.Construct#remove() * Modified: trunk/src/main/java/org/tmapi/core/TopicInUseException.java =================================================================== --- trunk/src/main/java/org/tmapi/core/TopicInUseException.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/TopicInUseException.java 2008-08-08 12:00:50 UTC (rev 62) @@ -17,7 +17,7 @@ * Thrown when an attempt is made to remove a {@link Topic} which is being used * as a type, as a reifier, or as a role player in an association, or in a scope. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public class TopicInUseException extends ModelConstraintException { @@ -36,7 +36,6 @@ super(sender, msg); } - /* (non-Javadoc) * @see org.tmapi.core.ModelConstraintException#getSender() */ Modified: trunk/src/main/java/org/tmapi/core/TopicMap.java =================================================================== --- trunk/src/main/java/org/tmapi/core/TopicMap.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/TopicMap.java 2008-08-08 12:00:50 UTC (rev 62) @@ -22,7 +22,7 @@ * Represents a * <a href="http://www.isotopicmaps.org/sam/sam-model/#d0e657">topic map item</a>. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public interface TopicMap extends Reifiable { @@ -54,10 +54,11 @@ /** * Returns a topic by its subject identifier. - * + * <p> * If no topic with the specified subject identifier exists, this method * returns <tt>null</tt>. - * + * </p> + * * @param sid The subject identifier of the topic to be returned. * @return A topic with the specified subject identifier or <tt>null</tt> * if no such topic exists in the topic map. @@ -66,10 +67,11 @@ /** * Returns a topic by its subject locator. - * + * <p> * If no topic with the specified subject locator exists, this method * returns <tt>null</tt>. - * + * </p> + * * @param slo The subject locator of the topic to be returned. * @return A topic with the specified subject locator or <tt>null</tt> * if no such topic exists in the topic map. @@ -107,10 +109,11 @@ /** * Returns a {@link Topic} instance with the specified subject identifier. - * + * <p> * This method returns either an existing {@link Topic} or creates a new * {@link Topic} instance with the specified subject identifier. - * + * </p> + * <p> * If a topic with the specified subject identifier exists in the topic map, * that topic is returned. If a topic with an item identifier equals to * the specified subject identifier exists, the specified subject identifier @@ -118,7 +121,8 @@ * If neither a topic with the specified subject identifier nor with an * item identifier equals to the subject identifier exists, a topic with * the subject identifier is created. - * + * </p> + * * @param sid The subject identifier the topic should contain. * @return A {@link Topic} instance with the specified subject identifier. */ @@ -126,10 +130,11 @@ /** * Returns a {@link Topic} instance with the specified subject locator. - * + * <p> * This method returns either an existing {@link Topic} or creates a new * {@link Topic} instance with the specified subject locator. - * + * </p> + * * @param slo The subject locator the topic should contain. * @return A {@link Topic} instance with the specified subject locator. */ @@ -137,10 +142,11 @@ /** * Returns a {@link Topic} instance with the specified item identifier. - * + * <p> * This method returns either an existing {@link Topic} or creates a new * {@link Topic} instance with the specified item identifier. - * + * </p> + * <p> * If a topic with the specified item identifier exists in the topic map, * that topic is returned. If a topic with a subject identifier equals to * the specified item identifier exists, the specified item identifier @@ -148,6 +154,7 @@ * If neither a topic with the specified item identifier nor with a * subject identifier equals to the subject identifier exists, a topic with * the item identifier is created. + * </p> * * @param iid The item identifier the topic should contain. * @return A {@link Topic} instance with the specified item identifier. @@ -157,10 +164,11 @@ /** * Returns a {@link Topic} instance with an automatically generated item * identifier. - * + * <p> * This method returns never an existing {@link Topic} but creates a * new one with an automatically generated item identifier. * How that item identifier is generated depends on the implementation. + * </p> * * @return The newly created {@link Topic} instance with an automatically * generated item identifier. @@ -192,26 +200,29 @@ /** * Closes use of this topic map instance. - * + * <p> * This method should be invoked by the application once it is finished * using this topic map instance. - * + * </p> + * <p> * Implementations may release any resources required for the * <tt>TopicMap</tt> instance or any of the {@link Construct} instances * contained by this instance. + * </p> */ public void close(); /** * Merges the topic map <code>other</code> into this topic map. - * + * <p> * All {@link Topic}s and {@link Association}s and all of their contents in * <tt>other</tt> will be added to this topic map. - * + * </p> + * <p> * All information items in <tt>other</tt> will be merged into this * topic map as defined by the * <a href="http://www.isotopicmaps.org/sam/sam-model/#d0e1862">Topic Maps - Data Model (TMDM) merging rules</a>. - * + * </p> * The merge process will not modify <tt>other</tt> in any way. * * @param other The topic map to be merged with this topic map instance. @@ -224,7 +235,7 @@ * @param indexInterface The index to return. * @return An index. * @throws UnsupportedOperationException If the implementation does not - * support indices. + * support indices or if the specified index is unsupported. */ public Index getIndex(Class<? extends Index> indexInterface); Modified: trunk/src/main/java/org/tmapi/core/TopicMapExistsException.java =================================================================== --- trunk/src/main/java/org/tmapi/core/TopicMapExistsException.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/TopicMapExistsException.java 2008-08-08 12:00:50 UTC (rev 62) @@ -18,15 +18,22 @@ * under a storage address (an IRI) that is already assigned to another * {@link TopicMap} in the same {@link TopicMapSystem}. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public class TopicMapExistsException extends TMAPIException { private static final long serialVersionUID = -1721148856137546269L; - public TopicMapExistsException(String msg) { - super(msg); + /** + * Constructs a new <tt>TopcMapExistsException</tt> with the specified + * detail message. + * + * @param message The detail message. This message is saved for later + * retrieval by the {@link #getMessage()} method. + */ + public TopicMapExistsException(String message) { + super(message); } } Modified: trunk/src/main/java/org/tmapi/core/TopicMapSystem.java =================================================================== --- trunk/src/main/java/org/tmapi/core/TopicMapSystem.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/TopicMapSystem.java 2008-08-08 12:00:50 UTC (rev 62) @@ -22,7 +22,7 @@ * {@link TopicMap} objects. A TMAPI system may be capable of allowing a client * to create new {@link TopicMap} instances. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public interface TopicMapSystem { @@ -32,13 +32,14 @@ * specified storage address <tt>iri</tt>. * * The string is assumed to be in IRI notation. - * + * <p> * This method should return the same result as the following code: * <pre> * TopicMapSystem tmSys = ... // Assumed to be there * String iri = "http://www.example.org/tm"; * TopicMap tm = tmSys.getTopicMap(tmSys.createLocator(iri)); * </pre> + * </p> * * @see #getTopicMap(Locator) * @@ -102,13 +103,14 @@ * specified <tt>iri</tt>. * * The string is assumed to be in IRI notation. - * + * <p> * This method should return the same result as the following code: * <pre> * TopicMapSystem tmSys = ... // Assumed to be there * String iri = "http://www.example.org/tm"; * TopicMap tm = tmSys.createTopicMap(tmSys.createLocator(iri)); * </pre> + * </p> * * @see #createTopicMap(Locator) * @@ -122,11 +124,12 @@ /** * Returns the value of the feature specified by <tt>featureName</tt> * for this TopicMapSystem instance. - * + * <p> * The features supported by the TopicMapSystem and the value for each * feature is set when the TopicMapSystem is created by a call to * {@link TopicMapSystemFactory#newTopicMapSystem()} and cannot be modified * subsequently. + * </p> * * @param featureName The name of the feature to check * @return <tt>true</tt> if the named feature is enabled this TopicMapSystem @@ -141,16 +144,19 @@ /** * Returns a property in the underlying implementation of * {@link TopicMapSystem}. - * + * <p> * A list of the core properties defined by TMAPI can be found at * <a href="http://tmapi.org/properties/">http://tmapi.org/properties/</a>. - * + * </p> + * <p> * An implementation is free to support properties other than the core ones. - * + * </p> + * <p> * The properties supported by the TopicMapSystem * and the value for each property is set when the TopicMapSystem is created * by a call to {@link TopicMapSystemFactory#newTopicMapSystem()} and cannot * be modified subsequently. + * </p> * * @param propertyName The name of the property to retrieve. * @return The value set for the property or <tt>null</tt> if no value is @@ -161,10 +167,11 @@ /** * Applications SHOULD call this method when the TopicMapSystem instance is * no longer required. - * + * <p> * Once the TopicMapSystem instance is closed, the TopicMapSystem and any * object retrieved from or created in this TopicMapSystem MUST NOT be used * by the application. + * </p> * * An implementation of the TopicMapSystem interface may use this method to * clean up any resources used by the implementation. Modified: trunk/src/main/java/org/tmapi/core/TopicMapSystemFactory.java =================================================================== --- trunk/src/main/java/org/tmapi/core/TopicMapSystemFactory.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/TopicMapSystemFactory.java 2008-08-08 12:00:50 UTC (rev 62) @@ -31,7 +31,7 @@ * {@link #setProperty(String, Object)} methods prior to invoking * {@link #newTopicMapSystem()}. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public abstract class TopicMapSystemFactory { @@ -52,11 +52,12 @@ /** * Returns if the particular feature is supported by the * {@link TopicMapSystem}. - * + * <p> * Opposite to {@link #getFeature} this method returns if the requested * feature is generally available / supported by the underlying * {@link TopicMapSystem} and does not return the state (enabled/disabled) * of the feature. + * </p> * * @param featureName The name of the feature to check. * @return <tt>true</tt> if the requested feature is supported, @@ -83,9 +84,10 @@ /** * Sets a particular feature in the underlying implementation of * {@link TopicMapSystem}. - * + * <p> * A list of the core features can be found at * <a href="http://tmapi.org/features/">http://tmapi.org/features/</a>. + * </p> * * @param featureName The name of the feature to be set. * @param enable <tt>true</tt> to enable the feature, @@ -102,9 +104,10 @@ /** * Gets the value of a property in the underlying implementation of * {@link TopicMapSystem}. - * + * <p> * A list of the core properties defined by TMAPI can be found at * <a href="http://tmapi.org/properties/">http://tmapi.org/properties/</a>. + * </p> * * An implementation is free to support properties other than the core ones. * @@ -117,10 +120,10 @@ /** * Sets a property in the underlying implementation of * {@link TopicMapSystem}. - * + * <p> * A list of the core properties defined by TMAPI can be found at * <a href="http://tmapi.org/properties/">http://tmapi.org/properties/</a>. - * + * </p> * An implementation is free to support properties other than the core ones. * * @param propertyName The name of the property to be set. @@ -189,6 +192,7 @@ * @throws FactoryConfigurationException * If the specified implementation class could not be loaded. */ + @SuppressWarnings("unchecked") private static Class<? extends TopicMapSystemFactory> getImplementationClass() throws FactoryConfigurationException { String implClassName = getClassNameFromProperties(); Modified: trunk/src/main/java/org/tmapi/core/Typed.java =================================================================== --- trunk/src/main/java/org/tmapi/core/Typed.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/Typed.java 2008-08-08 12:00:50 UTC (rev 62) @@ -19,7 +19,7 @@ * {@link Association}s, {@link Role}s, {@link Occurrence}s, and * {@link Name}s are typed. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public interface Typed extends Construct { Modified: trunk/src/main/java/org/tmapi/core/Variant.java =================================================================== --- trunk/src/main/java/org/tmapi/core/Variant.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/core/Variant.java 2008-08-08 12:00:50 UTC (rev 62) @@ -19,7 +19,7 @@ * Represents a * <a href="http://www.isotopicmaps.org/sam/sam-model/#sect-variant">variant item</a>. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public interface Variant extends DatatypeAware { Modified: trunk/src/main/java/org/tmapi/index/Index.java =================================================================== --- trunk/src/main/java/org/tmapi/index/Index.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/index/Index.java 2008-08-08 12:00:50 UTC (rev 62) @@ -16,7 +16,7 @@ /** * Base interface for all indices. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public interface Index { @@ -43,12 +43,13 @@ /** * Indicates whether the index is updated automatically. - * + * <p> * If the value is <tt>true</tt>, then the index is automatically kept * synchronized with the topic map as values are changed. * If the value is <tt>false</tt>, then the {@link Index#reindex()} * method must be called to resynchronize the index with the topic map * after values are changed. + * </p> * * @return <tt>true</tt> if index is updated automatically, <tt>false</tt> otherwise. */ Modified: trunk/src/main/java/org/tmapi/index/LiteralIndex.java =================================================================== --- trunk/src/main/java/org/tmapi/index/LiteralIndex.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/index/LiteralIndex.java 2008-08-08 12:00:50 UTC (rev 62) @@ -23,7 +23,7 @@ /** * Index for literal values stored in a topic map. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public interface LiteralIndex extends Index { @@ -43,12 +43,12 @@ /** * Returns the {@link Occurrence}s in the topic map whose value property * matches the IRI represented by <tt>value</tt>. - * + * <p> * Those {@link Occurrence}s which have a datatype equal to * <a href="http://www.w3.org/TR/xmlschema-2/#anyURI">xsd:anyURI</a> * and their value property is equal to {@link Locator#getReference()} * are returned. - * + * </p> * The return value may be empty but must never be <tt>null</tt>. * * @param value The value of the {@link Occurrence}s to be returned. @@ -83,12 +83,12 @@ /** * Returns the {@link Variant}s in the topic map whose value property * matches the IRI represented by <tt>value</tt>. - * + * <p> * Those {@link Variant}s which have a datatype equal to * <a href="http://www.w3.org/TR/xmlschema-2/#anyURI">xsd:anyURI</a> * and their value property is equal to {@link Locator#getReference()} * are returned. - * + * </p> * The return value may be empty but must never be <tt>null</tt>. * * @param value The value of the {@link Variant}s to be returned. Modified: trunk/src/main/java/org/tmapi/index/ScopedIndex.java =================================================================== --- trunk/src/main/java/org/tmapi/index/ScopedIndex.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/index/ScopedIndex.java 2008-08-08 12:00:50 UTC (rev 62) @@ -28,7 +28,7 @@ * {@link Name}s, and {@link Variant}s by their scope property and to * {@link Topic}s which are used as theme in a scope. * - * @author TMAPI <a href="http://www.tmapi.org">tmapi.org</a> + * @author <a href="http://tmapi.org/">The TMAPI Project</a> * @version $Rev$ - $Date$ */ public interface ScopedIndex extends Index { Modified: trunk/src/main/java/org/tmapi/index/TypeInstanceIndex.java =================================================================== --- trunk/src/main/java/org/tmapi/index/TypeInstanceIndex.java 2008-08-07 11:25:25 UTC (rev 61) +++ trunk/src/main/java/org/tmapi/index/TypeInstanceIndex.java 2008-08-08 12:00:50 UTC (rev 62) @@ -24,29 +24,30 @@ /** * Index for type-instance relationships between {@link Topic}s * and for {@link org.tmapi.core.Typed} Topic Maps constructs. - * + * <p> * This index provides access to {@link Topic}s used in * <a href="http://www.isotopicmaps.org/sam/sam-model/#sect-types">type-instan... [truncated message content] |