org.ceryle.tm
Interface Facet

All Known Implementing Classes:

FacetImpl

public interface Facet

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

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

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

which defines the Topics:

Topic	PSI	type/notes
facets	http://purl.org/ceryle/psi/facets/#Facets	Topic: PSI class
hasFacet	http://purl.org/ceryle/psi/facets/#HasFacet	Topic: predicate
facet	http://purl.org/ceryle/psi/facets/#Facet	Topic: role
faceted	http://purl.org/ceryle/psi/facets/#Faceted	Topic: role
facetType	http://purl.org/ceryle/psi/facets/#FacetType	Topic: type
facetName	http://purl.org/ceryle/psi/facets/#FacetName	BaseName: string value or ref
facetValue	http://purl.org/ceryle/psi/facets/#FacetValue	Occurrence: string value or ref
facetDefault	http://purl.org/ceryle/psi/facets/#FacetDefault	Occurrence: string value or ref
facetMinIncl	http://purl.org/ceryle/psi/facets/#FacetMinIncl	Occurrence: string value or ref
facetMaxIncl	http://purl.org/ceryle/psi/facets/#FacetMaxIncl	Occurrence: string value or ref
facetMinExcl	http://purl.org/ceryle/psi/facets/#FacetMinExcl	Occurrence: string value or ref
facetMaxExcl	http://purl.org/ceryle/psi/facets/#FacetMaxExcl	Occurrence: string value or ref

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

Copyright 2001-2007 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: Facet.java,v 3.6 2007-06-15 12:09:32 altheim Exp $

Author:

Murray Altheim

See Also:

FacetImpl

Method Summary

Topic	getFacet() Return the facet Topic.
Occurrence	getFacetDefault() Return the facet Default as a Topic Occurrence.
Topic	getFaceted() Return the faceted Topic.
Association	getFacetLink() Return the facet Association.
Occurrence	getFacetMaxExcl() Return the facet maximum exclusive constraint as a Topic Occurrence.
Occurrence	getFacetMaxIncl() Return the facet maximum inclusive constraint as a Topic Occurrence.
Occurrence	getFacetMinExcl() Return the facet minimum exclusive constraint as a Topic Occurrence.
Occurrence	getFacetMinIncl() Return the facet minimum inclusive constraint as a Topic Occurrence.
BaseName	getFacetName() Return the facet Name as a String.
Collection	getFacetTypes(boolean includeMergedTopics) Return the types of this Facet, and optionally, of all merged Topics.
Occurrence	getFacetValue() Return the facet value as an Occurrence.
void	setFacetDefault(Object facetDefault) Set the facet default value to the object facetDefault, which must be either a String or a Locator.
void	setFacetMaxExcl(Object facetMaxExcl) Set the facet maximum exclusive constraint to the Object facetMaxExcl, which must be either a String or a Locator.
void	setFacetMaxIncl(Object facetMaxIncl) Set the facet maximum inclusive constraint to the Object facetMaxIncl, which must be either a String or a Locator.
void	setFacetMinExcl(Object facetMinExcl) Set the facet minimum exclusive constraint to the Object facetMinExcl, which must be either a String or a Locator.
void	setFacetMinIncl(Object facetMinIncl) Set the facet minimum inclusive constraint to the Object facetMinIncl, which must be either a String or a Locator.
void	setFacetName(String facetName) Set the facet Name to the String facetName.
void	setFacetType(Topic facetType, boolean replace) Add the Topic facetType as a type of this Facet.
void	setFacetValue(Object facetValue) Set the facet Value to the Object facetValue, which must be either a String or a Locator.

Method Detail

getFaceted

Topic getFaceted()

Return the faceted Topic.

getFacet

Topic getFacet()

Return the facet Topic.

getFacetLink

Association getFacetLink()

Return the facet Association.

setFacetType

void setFacetType(Topic facetType,
                  boolean replace)
                  throws TopicMapException

Add the Topic facetType as a type of this Facet. If the boolean replace is true, any existing types are removed.

Throws:

TopicMapException

getFacetTypes

Collection getFacetTypes(boolean includeMergedTopics)

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

setFacetValue

void setFacetValue(Object facetValue)
                   throws TopicMapException

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

Throws:

TopicMapException

getFacetValue

Occurrence getFacetValue()

Return the facet value as an Occurrence.

setFacetName

void setFacetName(String facetName)
                  throws TopicMapException

Set the facet Name to the String facetName.

Throws:

TopicMapException

getFacetName

BaseName getFacetName()

Return the facet Name as a String.

setFacetDefault

void setFacetDefault(Object facetDefault)
                     throws TopicMapException

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

Throws:

TopicMapException

getFacetDefault

Occurrence getFacetDefault()

Return the facet Default as a Topic Occurrence.

setFacetMinIncl

void setFacetMinIncl(Object facetMinIncl)
                     throws TopicMapException

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

Throws:

TopicMapException

getFacetMinIncl

Occurrence getFacetMinIncl()

Return the facet minimum inclusive constraint as a Topic Occurrence.

setFacetMaxIncl

void setFacetMaxIncl(Object facetMaxIncl)
                     throws TopicMapException

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

Throws:

TopicMapException

getFacetMaxIncl

Occurrence getFacetMaxIncl()

Return the facet maximum inclusive constraint as a Topic Occurrence.

setFacetMinExcl

void setFacetMinExcl(Object facetMinExcl)
                     throws TopicMapException

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

Throws:

TopicMapException

getFacetMinExcl

Occurrence getFacetMinExcl()

Return the facet minimum exclusive constraint as a Topic Occurrence.

setFacetMaxExcl

void setFacetMaxExcl(Object facetMaxExcl)
                     throws TopicMapException

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

Throws:

TopicMapException

getFacetMaxExcl

Occurrence getFacetMaxExcl()

Return the facet maximum exclusive constraint as a Topic Occurrence.