Class LinkingTypesStore

Method Details

• getInstance

  public static LinkingTypesStore getInstance()

  Returns the current store instance. If no instance was set, returns a default store containing only the standard types.

  Returns:

  the current instance.

  See Also:

  • setInstance(LinkingTypesStore)

• setInstance

  public static void setInstance(LinkingTypesStore store)

  Replaces the current store instance with the given one.

  Parameters:

  store - the new store.

• getResourceTypes

  public Collection<ResourceType> getResourceTypes() throws LinkingTypesStoreException

  Gets the resource types available.

  Returns:

  all available resource types.

  Throws:

  LinkingTypesStoreException - if an error occurs while querying the store.

• getSupportedResourceTypes

  public Collection<ResourceType> getSupportedResourceTypes() throws LinkingTypesStoreException

  Gets the supported resource types.

  Returns:

  the supported resource types.

  Throws:

  LinkingTypesStoreException - if an error occurs while querying the store.

  See Also:

  • ResourceType.supportedValues()

• getResourceType

  public Optional<ResourceType> getResourceType(URI resourceTypeURI) throws LinkingTypesStoreException

  Gets a resource type from its URI, if available.

  Parameters:

  resourceTypeURI - the URI

  Returns:

  the resource type, Optional.empty() otherwise.

  Throws:

  LinkingTypesStoreException - if an error occurs while querying the store.

• getLinkTypes

  public Collection<LinkType> getLinkTypes() throws LinkingTypesStoreException

  Gets the link types available.

  Returns:

  all available link types.

  Throws:

  LinkingTypesStoreException - if an error occurs while querying the store.

• getSupportedLinkTypes

  public Collection<LinkType> getSupportedLinkTypes() throws LinkingTypesStoreException

  Gets the link types that are supported.

  Returns:

  the supported link types.

  Throws:

  LinkingTypesStoreException - if an error occurs while querying the store.

  See Also:

  • LinkType.supportedValues()

• isUserSelectable

  public boolean isUserSelectable(LinkType linkType) throws LinkingTypesStoreException

  Determines whether the end-user must be offered to create a link of such type. Most of the link types can be initiated by the end-user on his local resource, but some can only be created from the opposite bound, typically the tracksChangeSet one.

  Parameters:

  linkType - the link type to check

  Returns:

  true if the end-user can create such link on his local resource, false otherwise.

  Throws:

  LinkingTypesStoreException - if an error occurs while querying the store.

• isNonStorableLink

  public boolean isNonStorableLink(URI linkType) throws LinkingTypesStoreException

  Determines whether the link type is only present to be able to display a backlink title and should never be stored.

  Parameters:

  linkType - Property definition of the LinkType.

  Returns:

  true if the link type should never be stored, false otherwise.

  Throws:

  LinkingTypesStoreException - if an error prevents link types from being retrieved.

  Since:

  3.13.0

• getAssociationTypes

  public Collection<AssociationType> getAssociationTypes() throws LinkingTypesStoreException

  Gets the association types available.

  Returns:

  all available association types.

  Throws:

  LinkingTypesStoreException - if an error occurs while querying the store.

• getSupportedAssociationTypes

  public Collection<AssociationType> getSupportedAssociationTypes() throws LinkingTypesStoreException

  Gets the supported association types.

  Returns:

  the supported association types.

  Throws:

  LinkingTypesStoreException - if an error occurs while querying the store.

  See Also:

  • AssociationType.supportedValues()