|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.silverpeas.pdc.web.PdcEntity
public class PdcEntity
A web entity representing the classification plan (named PdC). The classification plan can be either the one modeled for the Silverpeas system or the one parametrized for a given Silverpeas component instance. It defines the axis that can be used in the classification of a resource managed by a component instance.
Field Summary | |
---|---|
static UserThesaurusHolder |
NoThesaurus
The value representing an absence of thesaurus. |
Constructor Summary | |
---|---|
protected |
PdcEntity()
|
Method Summary | |
---|---|
static PdcEntity |
aPdcEntityWithAxis(List<Axis> usedAxis,
String inLanguage,
URI atURI,
UserThesaurusHolder withThesaurus)
|
static PdcEntity |
aPdcEntityWithUsedAxis(List<UsedAxis> usedAxis,
String inLanguage,
URI atURI,
UserThesaurusHolder withThesaurus)
Creates a new web entity of a PdC containing the specified axis whose terms are expressed in the specified language and with the specified user thesaurus. |
static URI |
atURI(URI uri)
A convenient method to enhance the readability of creators. |
boolean |
equals(Object obj)
|
List<PdcAxis> |
getAxis()
Gets the axis of this PdC. |
URI |
getURI()
Gets the URI at which this resource is published and can be accessed. |
int |
hashCode()
|
static String |
inLanguage(String language)
A convenient method to enhance the readability of the method calls that expect the language as argument. |
String |
toString()
|
PdcEntity |
withAsAxis(List<PdcAxis> axis)
Adds the specified PdC axis among the others axis of this PdC. |
static List<UsedAxis> |
withAxis(List<UsedAxis> axis)
A convenient method to enhance the readability of the method calls in which the axis are passed as argument. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final UserThesaurusHolder NoThesaurus
Constructor Detail |
---|
protected PdcEntity()
Method Detail |
---|
public static PdcEntity aPdcEntityWithUsedAxis(List<UsedAxis> usedAxis, String inLanguage, URI atURI, UserThesaurusHolder withThesaurus) throws ThesaurusException
usedAxis
- the axis to use in the PdC.inLanguage
- the language in which the PdC's terms should be translated.atURI
- the URI at which the PdC can be found.withThesaurus
- the thesaurus to use with this PdC. The thesaurus will be use to set the
synonyms of each value of the different PdC's axis. NoThesaurus if the user has no thesaurus
configured.
ThesaurusException
- if an error occurs while using the thesaurus to find the synonyms of
values of the different PdC's axis.public static PdcEntity aPdcEntityWithAxis(List<Axis> usedAxis, String inLanguage, URI atURI, UserThesaurusHolder withThesaurus) throws ThesaurusException
ThesaurusException
public static List<UsedAxis> withAxis(List<UsedAxis> axis)
axis
- the axis of the PdC.
public static String inLanguage(String language)
language
- the language of a user.
public URI getURI()
getURI
in interface Exposable
public List<PdcAxis> getAxis()
public PdcEntity withAsAxis(List<PdcAxis> axis)
axis
- the axis of this PdC.
public static URI atURI(URI uri)
uri
- the URI at which the classification is published.
public boolean equals(Object obj)
equals
in class Object
public int hashCode()
hashCode
in class Object
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |