|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface Classification
The Classification interface is used to classify RegistryObject instances. A RegistryObject may be classified along multiple dimensions by adding zero or more Classification instances to the RegistryObject. For example, an Organization may be classified by its industry, by the products it sells and by its geographical location. In this example the RegistryObject would have at least three Classification instances added to it. The RegistryObject interface provides several addClassification methods to allow a client to add Classification instances to a Registry Object.
Figure 1 shows how a Classification classifies a RegistryObject using a ClassificationScheme.
When a Classification instance is used to classify a RegistryObject using an internal taxonomy it is referred to as an internal Classification. A client must call the setConcept method on a Classification and define a reference to a Concept instance from the Classification instance in order for that Classification to use an internal taxonomy. It is not necessary for the client to call setClassificationScheme for internal Classifications since the classifying Concept already knows it root ClassificationScheme.
RegistryObject,
Concept| Method Summary | |
|---|---|
ClassificationScheme |
getClassificationScheme()
Gets the ClassificationScheme that is used in classifying the object. |
RegistryObject |
getClassifiedObject()
Gets the Object that is being classified. |
Concept |
getConcept()
Gets the Concept that is classifying the object. |
String |
getValue()
Gets the taxonomy value for this Classification. |
boolean |
isExternal()
Returns true if this is an external classification. |
void |
setClassificationScheme(ClassificationScheme classificationScheme)
Sets the ClassificationScheme for this external classification. |
void |
setClassifiedObject(RegistryObject classifiedObject)
Sets the object that is being classified. |
void |
setConcept(Concept concept)
Sets the concept for this internal classification. |
void |
setValue(String value)
Sets the taxonomy value for this external Classification. |
| Methods inherited from interface javax.xml.registry.infomodel.ExtensibleObject |
|---|
addSlot, addSlots, getSlot, getSlots, removeSlot, removeSlots |
| Method Detail |
|---|
Concept getConcept()
throws JAXRException
JAXRException - If the JAXR provider encounters an internal error
void setConcept(Concept concept)
throws JAXRException
This method should be used mutually exclusively with the setClassificationScheme method.
concept - the Concept that is classifying the classified object.
JAXRException - If the JAXR provider encounters an internal error
ClassificationScheme getClassificationScheme()
throws JAXRException
JAXRException - If the JAXR provider encounters an internal errorClassificationScheme
void setClassificationScheme(ClassificationScheme classificationScheme)
throws JAXRException
If this method is called then you must also call setValue method. This method should be used mutually exclusively with the setConcept method.
classificationScheme - the ClassificationScheme used by this Classification
JAXRException - If the JAXR provider encounters an internal error
String getValue()
throws JAXRException
JAXRException - If the JAXR provider encounters an internal error
void setValue(String value)
throws JAXRException
value - the taxonomy value used by this external Classification
JAXRException - If the JAXR provider encounters an internal error
RegistryObject getClassifiedObject()
throws JAXRException
JAXRException - If the JAXR provider encounters an internal error
void setClassifiedObject(RegistryObject classifiedObject)
throws JAXRException
classifiedObject - the RegistryObject that is classified by this Classification
JAXRException - If the JAXR provider encounters an internal error
boolean isExternal()
throws JAXRException
true if this is an external Classification; false otherwise
JAXRException - If the JAXR provider encounters an internal error
|
Java EE 5 SDK | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright 2006 Sun Microsystems, Inc. All rights reserved.