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
| Modifier and Type | Method and Description |
|---|---|
| public ClassificationScheme | Returns: the ClassificationScheme used by this ClassificationGets the ClassificationScheme that is used in classifying the object. |
| public RegistryObject | Returns: the RegistryObject that is classified by this ClassificationGets the Object that is being classified. |
| public Concept | Returns: the Concept that is classifying the classified object. null if this is a external ClassificationGets the Concept that is classifying the object. |
| public String | Returns: the value of the taxonomy element if external Classification; the value of the Concept representing the taxonomy element if internal ClassificationGets the taxonomy value for this Classification. |
| public boolean | Returns: true if this is an external Classification; false otherwiseReturns true if this is an external classification. |
| public void | setClassificationScheme(ClassificationScheme
the ClassificationScheme used by this Classification classificationScheme)Sets the ClassificationScheme for this external classification. |
| public void | setClassifiedObject(RegistryObject
the RegistryObject that is classified by this Classification classifiedObject)Sets the object that is being classified. |
| public void | setConcept(Concept
the Concept that is classifying the classified object. concept)Sets the concept for this internal classification. |
| public void |
| getClassificationScheme | back to summary |
|---|---|
| public ClassificationScheme getClassificationScheme() throws JAXRException Gets the ClassificationScheme that is used in classifying the object. If the Classification is an internal Classification then this method should return the value returned by calling the getClassificationScheme method on the Concept representing the taxonomy element.
| |
| getClassifiedObject | back to summary |
|---|---|
| public RegistryObject getClassifiedObject() throws JAXRException Gets the Object that is being classified.
| |
| getConcept | back to summary |
|---|---|
| public Concept getConcept() throws JAXRException Gets the Concept that is classifying the object.
| |
| getValue | back to summary |
|---|---|
| public String getValue() throws JAXRException Gets the taxonomy value for this Classification.
| |
| isExternal | back to summary |
|---|---|
| public boolean isExternal() throws JAXRException Returns true if this is an external classification.
| |
| setClassificationScheme | back to summary |
|---|---|
| public void setClassificationScheme(ClassificationScheme classificationScheme) throws JAXRException Sets the ClassificationScheme for this external classification. If this method is called then you must also call setValue method. This method should be used mutually exclusively with the setConcept method.
| |
| setClassifiedObject | back to summary |
|---|---|
| public void setClassifiedObject(RegistryObject classifiedObject) throws JAXRException Sets the object that is being classified.
| |
| setConcept | back to summary |
|---|---|
| public void setConcept(Concept concept) throws JAXRException Sets the concept for this internal classification. This method should be used mutually exclusively with the setClassificationScheme method.
| |
| setValue | back to summary |
|---|---|
| public void setValue(String value) throws JAXRException Sets the taxonomy value for this external Classification.
| |