Class Classification
java.lang.Object
dev.jcputney.elearning.parser.input.lom.Classification
- All Implemented Interfaces:
Serializable
Represents the classification information about a learning object in a Learning Object Metadata
(LOM) document. The classification provides information about the purpose and taxonomy paths of
the learning object, aiding in its categorization and retrieval.
Schema snippet:
<complexType name="classification">
<choice minOccurs="0" maxOccurs="unbounded">
<group ref="purpose"/>
<group ref="taxonPath"/>
<group ref="description"/>
<group ref="keyword"/>
<group ref="ex:customElements"/>
</choice>
<attributeGroup ref="ag:classification"/>
</complexType>
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanRetrieves the description of the classification.Retrieves the keywords associated with the classification.Retrieves the purpose of the classification.Retrieves the list of taxon paths associated with this classification.inthashCode()voidsetDescription(UnboundLangString description) Sets the description of the classification.voidsetKeywords(UnboundLangString keywords) Sets the keywords associated with the classification.voidsetPurpose(SourceValuePair<Purpose> purpose) Sets the purpose of the classification.voidsetTaxonPaths(List<TaxonPath> taxonPaths) Sets the list of taxon paths associated with this classification.
-
Constructor Details
-
Classification
public Classification()Default constructor for the Classification class. This constructor initializes a new instance of the Classification class with default, uninitialized values for all fields. It performs no additional operations.
-
-
Method Details
-
getPurpose
Retrieves the purpose of the classification. The purpose is encapsulated as a source-value pair, where the source indicates the context or origin of the value, and the value specifies the actual purpose.- Returns:
- a SourceValuePair containing the source and value representing the purpose
-
setPurpose
Sets the purpose of the classification. The purpose is encapsulated as a source-value pair, where the source indicates the context or origin of the value, and the value specifies the actual purpose.- Parameters:
purpose- a SourceValuePair containing the source and value representing the purpose
-
getTaxonPaths
Retrieves the list of taxon paths associated with this classification. A taxon path represents a hierarchical classification or categorization.- Returns:
- a list of
TaxonPathobjects associated with the classification.
-
setTaxonPaths
Sets the list of taxon paths associated with this classification. A taxon path represents a hierarchical classification or categorization.- Parameters:
taxonPaths- a list ofTaxonPathobjects to associate with the classification
-
getDescription
Retrieves the description of the classification. The description is represented as a list of language strings, allowing for multilingual support.- Returns:
- an UnboundLangString object containing the multilingual description of the classification.
-
setDescription
Sets the description of the classification. The description is represented as an UnboundLangString, allowing for multilingual support.- Parameters:
description- an UnboundLangString object containing the multilingual description of the classification
-
getKeywords
Retrieves the keywords associated with the classification. The keywords are represented as an UnboundLangString object, which supports multilingual strings.- Returns:
- an UnboundLangString object containing the keywords of the classification.
-
setKeywords
Sets the keywords associated with the classification. The keywords are represented as an UnboundLangString, allowing for multilingual support.- Parameters:
keywords- an UnboundLangString object containing the keywords to associate with the classification
-
equals
-
hashCode
public int hashCode()
-