javax.xml.registry.infomodel.Concept Maven / Gradle / Ivy
The newest version!
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://glassfish.dev.java.net/public/CDDLv1.0.html or
* glassfish/bootstrap/legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at glassfish/bootstrap/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2007 Sun Microsystems, Inc. All rights reserved.
*/
package javax.xml.registry.infomodel;
import java.util.*;
import javax.xml.registry.*;
/**
* The Concept interface is used to represent taxonomy elements and their structural relationship with each other in order to describe an internal taxonomy.
* Concept instances are used to define tree structures where the root of the tree is a ClassificationScheme instance and each node in the tree is a Concept instance. Two Concepts may be defined as being equivalent.
* Figure 1 shows how Concept instances are used to represent taxonomy elements and their structural relationship with each other in order to describe an internal taxonomy.
*
*
* 
*
Figure 1. Using Concepts to Represent Taxonomy Elements
*
*
*
* @see RegistryObject
* @see Classification
* @see ClassificationScheme
* @author Farrukh S. Najmi
*/
public interface Concept extends RegistryObject {
/**
* Gets the value (usually a code in a taxonomy) associated with this Concept.
*
* - Capability Level: 0
*
* @return the value (usually a taxonomy value) associated with this Concept
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
String getValue() throws JAXRException;
/**
* Sets the value (usually a taxonomy value) associated with this Concept.
*
* - Capability Level: 0
*
* @param value the value (usually a taxonomy value) associated with this Concept
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
void setValue(String value) throws JAXRException;
/**
* Adds a child Concept.
*
* - Capability Level: 0
*
* @param concept the concept being added as a child of this object
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
void addChildConcept(Concept concept) throws JAXRException;
/**
* Adds a Collection of Concept children.
*
* - Capability Level: 0
*
* @param concepts the Collection of Concepts being added as a children of this object
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
void addChildConcepts(Collection concepts) throws JAXRException;
/**
* Removes a child Concept.
*
* - Capability Level: 0
*
* @param concept the concept being removed as a child Concept of this object
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
void removeChildConcept(Concept concept) throws JAXRException;
/**
* Removes a Collection of children Concepts.
*
* - Capability Level: 0
*
* @param concepts the Collection of Concepts being removed as children Concepts of this object
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
void removeChildConcepts(Collection concepts) throws JAXRException;
/**
* Gets number of children.
*
* - Capability Level: 0
*
* @return the number of children Concepts
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
int getChildConceptCount() throws JAXRException;
/**
* Gets all immediate children Concepts.
*
* - Capability Level: 0
*
* @see javax.xml.registry.infomodel.Concept
* @return Collection of Concept instances. The Collection may be empty but not null.
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
Collection getChildrenConcepts() throws JAXRException;
/**
* Gets all descendant Concepts.
*
* - Capability Level: 0
*
* @see javax.xml.registry.infomodel.Concept
* @return Collection of Concept instances. The Collection may be empty but not null.
* @throws JAXRException If the JAXR provider encounters an internal error
*
*
*/
Collection getDescendantConcepts() throws JAXRException;
/**
* Gets the parent Concept or null if parent is a ClassificationScheme.
*
*
* - Capability Level: 0
*
*
* @return the Concept that is the parent of this object
* @throws JAXRException If the JAXR provider encounters an internal error
*
* @label parent
* @directed
* @supplierCardinality 0..1
* @associates <{javax.xml.registry.infomodel.Concept}>
*/
Concept getParentConcept() throws JAXRException;
/**
* Gets the ClassificationScheme that this Concept is a descendent of.
*
*
* - Capability Level: 0
*
* @return the ClassificationScheme that is the ancestor of this object. May return null
* @throws JAXRException If the JAXR provider encounters an internal error
*
* @label classificationScheme
* @directed
* @supplierCardinality 0..1
* @associates <{javax.xml.registry.infomodel.ClassificationScheme}>
*/
ClassificationScheme getClassificationScheme() throws JAXRException;
/**
* Gets the canonical path representation for this Concept.
*
*
* - Capability Level: 0
*
* @return the canonical path String representing this object
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
String getPath() throws JAXRException;
/**
* Gets the parent Concept or ClassificationScheme for this object.
*
*
* - Capability Level: 0
*
* @return the parent Concept or ClassificationScheme for this object
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
RegistryObject getParent() throws JAXRException;
}