org.apache.juddi.datatype.tmodel
Class TModel

java.lang.Object
  org.apache.juddi.datatype.tmodel.TModel

All Implemented Interfaces:

java.io.Serializable, RegistryObject

public class TModel
extends java.lang.Object
implements RegistryObject

"Descriptions of specifications for services or taxonomies. Basis for technical fingerprints" - XML Structure Reference The primary role that the tModel plays is to represent a technical spec. Implementors of that spec reference the tModel with a tModelKey in a bindingTemplate in the service definition. The other place that a tModel reference is used is in the identifierBag and categoryBag structures. Used in this context the tModel reference represents a relationship between the keyed name-value pairs to the namespace within which they are meaningful. Eg, a tModel named "US tax codes". The tModel is still a specific concept but instead of being a technical specification it represents a unique namespace within which tax code IDs have meaning. Once this meaning is established a business can use the tModelKey for the tax code tModel as a unique reference that qualifies the entry in the identifierBag. UDDI has already defined a number of tModels including US tax codes, NAICS, UNSPC, and an unnamed geographic taxonomy. (See also KeyedReference).

Author:

Steve Viens (sviens@apache.org)

See Also:

Serialized Form

Field Summary

static java.lang.String	D_U_N_S_TMODEL_KEY D-U-N-S� Number Identifier System [dnb-com:D-U-N-S] This tModel is used for the Dun & Bradstreet D-U-N-S� Number identifier.
static java.lang.String	FAX_TMODEL_KEY Fax based web service [uddi-org:fax] This tModel is used to describe a web service that is invoked through fax transmissions.
static java.lang.String	FTP_TMODEL_KEY FTP based web service [uddi-org:ftp] This tModel is used to describe a web service that is invoked through file transfers via the ftp protocol.
static java.lang.String	GENERAL_KEYWORDS_TMODEL_KEY UDDI Other Taxonomy [uddi-org:misc-taxomony] This tModel defines an unidentified taxonomy.
static java.lang.String	HOMEPAGE_TMODEL_KEY HTTP Web Home Page URL [uddi-org:homepage] This tModel is used as the bindingTemplate fingerprint for a web home page reference.
static java.lang.String	HTTP_TMODEL_KEY Web browser or HTTP based web service [uddi-org:http] This tModel is used to describe a web service that is invoked through a web browser and/or the HTTP protocol.
static java.lang.String	IS_REPLACED_BY_TMODEL_KEY UDDI IsReplacedBy [uddi-org:isReplacedBy] An identifier system used to point (using UDDI keys) to the tModel (or businessEntity) that is the logical replacement for the one in which isReplacedBy is used.
static java.lang.String	ISO_CH_TMODEL_KEY ISO 3166 Geographic Taxonomy [uddi-org:iso-ch:3166-1999] This tModel defines the ISO 3166 geographic classification taxonomy.
static java.lang.String	NAICS_TMODEL_KEY Business Taxonomy: NAICS (1997 Release) [ntis-gov:naics:1997] This tModel defines the NAICS (North American Industry Classification System) 1997 Release industry taxonomy.
static java.lang.String	OPERATORS_TMODEL_KEY UDDI Operators [uddi-org:operators] This checked value set is used to identify UDDI operators.
static java.lang.String	OWNING_BUSINESS_TMODEL_KEY UDDI Owning Business [uddi-org:owningBusiness] This tModel identifies the businessEntity that published or owns the tagged information.
static java.lang.String	RELATIONSHIPS_TMODEL_KEY UDDI businessEntity relationship [uddi-org:relationships] This tModel is used to describe business relationships.
static java.lang.String	SMTP_TMODEL_KEY Email based web service [uddi-org:smtp] This tModel is used to describe a web service that is invoked through SMTP email transmissions.
static java.lang.String	TELEPHONE_TMODEL_KEY Telephone based web service [uddi-org:telephone] This tModel is used to describe a web service that is invoked through a telephone call and interaction by voice and/or touch-tone.
static java.lang.String	THOMAS_REGISTER_TMODEL_KEY Thomas Register Supplier Identifier Code System [thomasregister-com:supplierID] This tModel is used for the Thomas Register supplier identifier codes.
static java.lang.String	TYPES_TMODEL_KEY UDDI Type Taxonomy [uddi-org:types] This taxonomy assists in general categorization of the tModels themselves.
static java.lang.String	UNSPSC_73_TMODEL_KEY Product and Services Taxonomy:UNSPSC (Version 7.3) [unspsc-org:unspsc] This tModel defines the UNSPSC (Universal Standard Products and Services Classification) version 7.3 product and services taxonomy.
static java.lang.String	UNSPSC_TMODEL_KEY Product Taxonomy: UNSPSC (Version 3.1) [unspsc-org:unspsc:3-1] This tModel defines the UNSPSC (United Nations Standard Products and Services Code System) version 3.1 product taxonomy.

Constructor Summary

TModel()
Construct a new initialized TModel instance.

TModel(java.lang.String name)
Construct a brand new TModel with a given name.

TModel(java.lang.String name, java.lang.String key)
Construct a new tModel with a given name and key.

Method Summary

void	addCategory(KeyedReference keyedRef) Add a new category to this tModel.
void	addDescription(Description descr) Adds the given description.
void	addIdentifier(KeyedReference k) Add a new identifier to this tModel.
java.lang.String	getAuthorizedName() Returns the authorized name of this tModel.
CategoryBag	getCategoryBag() Returns the categorybag of this tModel.
java.util.Vector	getDescriptionVector() Returns the descriptions.
IdentifierBag	getIdentifierBag() Returns the identifierbag of this tModel.
Name	getName() Returns the name of this tModel.
java.lang.String	getOperator() Returns the operator of this tModel.
OverviewDoc	getOverviewDoc() Returns the overviewDoc of this tModel.
java.lang.String	getTModelKey() Returns the key of this tModel.
void	setAuthorizedName(java.lang.String name) Sets the authorized name of this tModel to the given name.
void	setCategoryBag(CategoryBag bag) Set the categorybag of this business entity to the given one.
void	setDescriptionVector(java.util.Vector descriptions) Sets the description list to the current one.
void	setIdentifierBag(IdentifierBag bag) Set the categorybag of this business entity to the given one.
void	setName(Name name) Sets the name of this tModel to the given name.
void	setName(java.lang.String nameValue) Sets the name of this tModel to the given name.
void	setOperator(java.lang.String operator) Sets the operator of this tModel to the given operator.
void	setOverviewDoc(OverviewDoc doc) Sets the overviewDoc of this tModel to the given overviewDoc.
void	setTModelKey(java.lang.String key) Sets the key of this tModel to the given key.

Methods inherited from class java.lang.Object

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

Field Detail

TYPES_TMODEL_KEY

public static final java.lang.String TYPES_TMODEL_KEY

UDDI Type Taxonomy [uddi-org:types] This taxonomy assists in general categorization of the tModels themselves.

See Also:

Constant Field Values

NAICS_TMODEL_KEY

public static final java.lang.String NAICS_TMODEL_KEY

Business Taxonomy: NAICS (1997 Release) [ntis-gov:naics:1997] This tModel defines the NAICS (North American Industry Classification System) 1997 Release industry taxonomy.

See Also:

Constant Field Values

UNSPSC_TMODEL_KEY

public static final java.lang.String UNSPSC_TMODEL_KEY

Product Taxonomy: UNSPSC (Version 3.1) [unspsc-org:unspsc:3-1] This tModel defines the UNSPSC (United Nations Standard Products and Services Code System) version 3.1 product taxonomy. This taxonomy has been superceeded by the Universal Standard Products and Services Classification (see UNSPSC_73_TMODEL_KEY) taxonomy.

See Also:

Constant Field Values

UNSPSC_73_TMODEL_KEY

public static final java.lang.String UNSPSC_73_TMODEL_KEY

Product and Services Taxonomy:UNSPSC (Version 7.3) [unspsc-org:unspsc] This tModel defines the UNSPSC (Universal Standard Products and Services Classification) version 7.3 product and services taxonomy.

See Also:

Constant Field Values

ISO_CH_TMODEL_KEY

public static final java.lang.String ISO_CH_TMODEL_KEY

ISO 3166 Geographic Taxonomy [uddi-org:iso-ch:3166-1999] This tModel defines the ISO 3166 geographic classification taxonomy.

See Also:

Constant Field Values

GENERAL_KEYWORDS_TMODEL_KEY

public static final java.lang.String GENERAL_KEYWORDS_TMODEL_KEY

UDDI Other Taxonomy [uddi-org:misc-taxomony] This tModel defines an unidentified taxonomy.

See Also:

Constant Field Values

OWNING_BUSINESS_TMODEL_KEY

public static final java.lang.String OWNING_BUSINESS_TMODEL_KEY

UDDI Owning Business [uddi-org:owningBusiness] This tModel identifies the businessEntity that published or owns the tagged information. Used with tModels to establish an 'owned' relationship with a registered businessEntity.

See Also:

Constant Field Values

RELATIONSHIPS_TMODEL_KEY

public static final java.lang.String RELATIONSHIPS_TMODEL_KEY

UDDI businessEntity relationship [uddi-org:relationships] This tModel is used to describe business relationships. Used in the publisher assertion messages.

See Also:

Constant Field Values

OPERATORS_TMODEL_KEY

public static final java.lang.String OPERATORS_TMODEL_KEY

UDDI Operators [uddi-org:operators] This checked value set is used to identify UDDI operators.

See Also:

Constant Field Values

D_U_N_S_TMODEL_KEY

public static final java.lang.String D_U_N_S_TMODEL_KEY

D-U-N-S� Number Identifier System [dnb-com:D-U-N-S] This tModel is used for the Dun & Bradstreet D-U-N-S� Number identifier.

See Also:

Constant Field Values

THOMAS_REGISTER_TMODEL_KEY

public static final java.lang.String THOMAS_REGISTER_TMODEL_KEY

Thomas Register Supplier Identifier Code System [thomasregister-com:supplierID] This tModel is used for the Thomas Register supplier identifier codes.

See Also:

Constant Field Values

IS_REPLACED_BY_TMODEL_KEY

public static final java.lang.String IS_REPLACED_BY_TMODEL_KEY

UDDI IsReplacedBy [uddi-org:isReplacedBy] An identifier system used to point (using UDDI keys) to the tModel (or businessEntity) that is the logical replacement for the one in which isReplacedBy is used.

See Also:

Constant Field Values

SMTP_TMODEL_KEY

public static final java.lang.String SMTP_TMODEL_KEY

Email based web service [uddi-org:smtp] This tModel is used to describe a web service that is invoked through SMTP email transmissions. These transmissions may be between people or applications.

See Also:

Constant Field Values

FAX_TMODEL_KEY

public static final java.lang.String FAX_TMODEL_KEY

Fax based web service [uddi-org:fax] This tModel is used to describe a web service that is invoked through fax transmissions. These transmissions may be between people or applications.

See Also:

Constant Field Values

FTP_TMODEL_KEY

public static final java.lang.String FTP_TMODEL_KEY

FTP based web service [uddi-org:ftp] This tModel is used to describe a web service that is invoked through file transfers via the ftp protocol.

See Also:

Constant Field Values

TELEPHONE_TMODEL_KEY

public static final java.lang.String TELEPHONE_TMODEL_KEY

Telephone based web service [uddi-org:telephone] This tModel is used to describe a web service that is invoked through a telephone call and interaction by voice and/or touch-tone.

See Also:

Constant Field Values

HTTP_TMODEL_KEY

public static final java.lang.String HTTP_TMODEL_KEY

Web browser or HTTP based web service [uddi-org:http] This tModel is used to describe a web service that is invoked through a web browser and/or the HTTP protocol.

See Also:

Constant Field Values

HOMEPAGE_TMODEL_KEY

public static final java.lang.String HOMEPAGE_TMODEL_KEY

HTTP Web Home Page URL [uddi-org:homepage] This tModel is used as the bindingTemplate fingerprint for a web home page reference.

See Also:

Constant Field Values

Constructor Detail

TModel

public TModel()

Construct a new initialized TModel instance.

TModel

public TModel(java.lang.String name)

Construct a brand new TModel with a given name. Assumes this is a brand new TModel instance and doesn't have a key yet - one is created in the constructor.

Parameters:

name - The name of the tModel.

TModel

public TModel(java.lang.String name,
              java.lang.String key)

Construct a new tModel with a given name and key.

Parameters:

name - The name of the tModel, given as a string.

key - The key of the tModel.

Method Detail

setTModelKey

public void setTModelKey(java.lang.String key)

Sets the key of this tModel to the given key.

Parameters:

key - The new key of this tModel.

getTModelKey

public java.lang.String getTModelKey()

Returns the key of this tModel.

Returns:

The key of this tModel.

setAuthorizedName

public void setAuthorizedName(java.lang.String name)

Sets the authorized name of this tModel to the given name.

Parameters:

name - The new authorized name of this tModel.

getAuthorizedName

public java.lang.String getAuthorizedName()

Returns the authorized name of this tModel.

Returns:

The authorized name of this tModel, or null if this tModel doesn't have an authorized name.

setName

public void setName(java.lang.String nameValue)

Sets the name of this tModel to the given name.

Parameters:

name - The new name of this tModel.

getName

public Name getName()

Returns the name of this tModel.

Returns:

The name of this tModel.

setName

public void setName(Name name)

Sets the name of this tModel to the given name.

Parameters:

name - The new name of this tModel.

addDescription

public void addDescription(Description descr)

Adds the given description.

Parameters:

descr - The description to add.

setDescriptionVector

public void setDescriptionVector(java.util.Vector descriptions)

Sets the description list to the current one. Ignores any object in the collection that is not an "instanceof" the Description class.

Parameters:

descriptions - Collection of Description objects to set

getDescriptionVector

public java.util.Vector getDescriptionVector()

Returns the descriptions.

Returns:

the descriptions. If the aren't any descriptions, an empty enumeration is returned.

setOverviewDoc

public void setOverviewDoc(OverviewDoc doc)

Sets the overviewDoc of this tModel to the given overviewDoc.

Parameters:

doc - The new overviewDoc of this tModel, or null if this tModel doesn't have an overviewDoc anymore.

getOverviewDoc

public OverviewDoc getOverviewDoc()

Returns the overviewDoc of this tModel.

Returns:

The overviewDoc of this tModel, or null if this tModel doesn't have an overviewDoc.

setOperator

public void setOperator(java.lang.String operator)

Sets the operator of this tModel to the given operator.

Parameters:

operator - The new operator of this tModel.

getOperator

public java.lang.String getOperator()

Returns the operator of this tModel.

Returns:

The operator of this tModel, or null if this tModel doesn't have an operator.

addIdentifier

public void addIdentifier(KeyedReference k)

Add a new identifier to this tModel.

Parameters:

k - The identifier to add.

getIdentifierBag

public IdentifierBag getIdentifierBag()

Returns the identifierbag of this tModel.

Returns:

The identifierbag of this tModel. If this tModel doesn't contain any identifiers, an empty enumeration is returned.

setIdentifierBag

public void setIdentifierBag(IdentifierBag bag)

Set the categorybag of this business entity to the given one.

Parameters:

bag - The new categorybag.

addCategory

public void addCategory(KeyedReference keyedRef)

Add a new category to this tModel.

Parameters:

keyedRef - The category to add.

getCategoryBag

public CategoryBag getCategoryBag()

Returns the categorybag of this tModel.

Returns:

The categorybag of this tModel. If this tModel doesn't contain any categories, an empty enumeration is returned.

setCategoryBag

public void setCategoryBag(CategoryBag bag)

Set the categorybag of this business entity to the given one.

Parameters:

bag - The new categorybag.