GNDMS 0.6.0
RESTful verison of GNDMS
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes

de.zib.gndms.logic.model.dspace.SliceKindConfiguration Class Reference

The slice kind configuration checks and accesses a ConfigHolder for a slice kind, which has to consist (at least) of the following fields:
uri - the uri for the slice kind as text
permission - the permissions of the slice kind as text according to an AccessMask
and may also contain:
metasubspaces - the meta-subspaces of the slice kind as text. More...

Inherits de::zib::gndms::common::logic::config::Configuration.

List of all members.

Public Member Functions

 SliceKindConfiguration (final String uri, final String permission, final String subspaces)
 Constructs a SliceKindConfiguration.
 SliceKindConfiguration (final String uri, final AccessMask permission, final String subspaces)
 Constructs a SliceKindConfiguration.
final boolean isValid ()
final String getStringRepresentation ()
final String getUri ()
 Returns the uri of a slice kind configuration.
final void setUri (final String uri)
 Sets the uri of a slice kind configuration.
final AccessMask getPermission ()
 Returns the permission of a slice kind configuration.
final void setPermission (final AccessMask permission)
 Sets the permission of a slice kind configuration.
final String getPermissionAsString ()
 Returns the permission of a slice kind configuration.
final void setPermission (final String permission)
 Sets the permission of a slice kind configuration.
final String getSubspaces ()
 Returns the subspaces of a slice kind configuration.
final void setSubspaces (final String subspaces)
 Sets the subspaces of a slice kind configuration.
final String toString ()
final boolean equals (final Object obj)
final int hashCode ()

Static Public Member Functions

static SliceKindConfiguration checkSliceKindConfig (final Configuration config)
 Converts a Configuration into a SliceKindConfiguration, if possible, and returns it, if valid.
static SliceKindConfiguration getSliceKindConfiguration (SliceKind slicekind)
 Constructs the slice kind configuration of a subspace.

Static Public Attributes

static final String URI = "uri"
 The key for the slice kind's uri.
static final String PERMISSION = "permission"
 The key for the slice kind's permission.
static final String SUBSPACES = "subspaces"
 The key for the slice kind's subspaces.

Private Attributes

String uri
 The uri of the slice kind.
AccessMask permission
 The permission of the slice kind.
String subspaces
 The subspaces of the slice kind.

Detailed Description

The slice kind configuration checks and accesses a ConfigHolder for a slice kind, which has to consist (at least) of the following fields:
uri - the uri for the slice kind as text
permission - the permissions of the slice kind as text according to an AccessMask
and may also contain:
metasubspaces - the meta-subspaces of the slice kind as text.

Author:
Ulrike Golas

Constructor & Destructor Documentation

de.zib.gndms.logic.model.dspace.SliceKindConfiguration.SliceKindConfiguration ( final String  uri,
final String  permission,
final String  subspaces 
)

Constructs a SliceKindConfiguration.

Parameters:
uriThe uri.
permissionThe permission as long value.
subspacesThe subspaces. 
                                                                                                         {
                this.uri = uri;
                setPermission(permission);
                this.subspaces = subspaces;
        }
de.zib.gndms.logic.model.dspace.SliceKindConfiguration.SliceKindConfiguration ( final String  uri,
final AccessMask  permission,
final String  subspaces 
)

Constructs a SliceKindConfiguration.

Parameters:
uriThe uri.
permissionThe permission as long value.
subspacesThe subspaces. 
                                                                                                             {
                this.uri = uri;
                this.permission = permission;
                this.subspaces = subspaces;
        }

Member Function Documentation

static SliceKindConfiguration de.zib.gndms.logic.model.dspace.SliceKindConfiguration.checkSliceKindConfig ( final Configuration  config) [static]

Converts a Configuration into a SliceKindConfiguration, if possible, and returns it, if valid.

Parameters:
configThe given configuration.
Returns:
The valid SliceKindConfiguration. 
                                                                                              {
                try {
                        SliceKindConfiguration sliceKindConfig = (SliceKindConfiguration) config;
                        if (sliceKindConfig.isValid()) {
                                return sliceKindConfig;
                        } else {
                                throw new WrongConfigurationException(
                                                "Wrong slice kind configuration");
                        }
                } catch (ClassCastException e) {
                        throw new WrongConfigurationException(
                                        "Wrong slice kind configuration");
                }
        }
final AccessMask de.zib.gndms.logic.model.dspace.SliceKindConfiguration.getPermission ( )

Returns the permission of a slice kind configuration.

Returns:
the permission 
                                                {
                return permission;
        }
final String de.zib.gndms.logic.model.dspace.SliceKindConfiguration.getPermissionAsString ( )

Returns the permission of a slice kind configuration.

Returns:
the permission 
                                                    {
                return permission.getAsString();
        }
static SliceKindConfiguration de.zib.gndms.logic.model.dspace.SliceKindConfiguration.getSliceKindConfiguration ( SliceKind  slicekind) [static]

Constructs the slice kind configuration of a subspace.

Parameters:
slicekindThe subspace.
Returns:
The configuration. 
                                                                                        {
                return new SliceKindConfiguration(slicekind.getId(), slicekind.getPermission(), slicekind.getSubspaces().toString());
        }
final String de.zib.gndms.logic.model.dspace.SliceKindConfiguration.getSubspaces ( )

Returns the subspaces of a slice kind configuration.

Returns:
the subspaces 
                                           {
                return subspaces;
        }
final String de.zib.gndms.logic.model.dspace.SliceKindConfiguration.getUri ( )

Returns the uri of a slice kind configuration.

Returns:
the uri 
                                     {
                return uri;
        }
final void de.zib.gndms.logic.model.dspace.SliceKindConfiguration.setPermission ( final String  permission)

Sets the permission of a slice kind configuration.

Parameters:
permissionthe permission to set 
                                                                 {
                try {
                        this.permission = AccessMask.fromString(permission);
                } catch (IllegalArgumentException e) {
                        throw new WrongConfigurationException(permission + " is no valid acces mask value.");
                } catch (NullPointerException e) {
                throw new WrongConfigurationException("Permission is null.");
        }
        }
final void de.zib.gndms.logic.model.dspace.SliceKindConfiguration.setPermission ( final AccessMask  permission)

Sets the permission of a slice kind configuration.

Parameters:
permissionthe permission to set 
                                                                     {
                this.permission = permission;
        }
final void de.zib.gndms.logic.model.dspace.SliceKindConfiguration.setSubspaces ( final String  subspaces)

Sets the subspaces of a slice kind configuration.

Parameters:
subspacesthe subspaces to set 
                                                               {
                this.subspaces = subspaces;
        }
final void de.zib.gndms.logic.model.dspace.SliceKindConfiguration.setUri ( final String  uri)

Sets the uri of a slice kind configuration.

Parameters:
urithe uri to set 
                                                   {
                this.uri = uri;
        }
The documentation for this class was generated from the following file:
 All Classes Namespaces Functions Variables
Generated on Wed Feb 15 2012 15:07:01 for GNDMS by  doxygen 1.7.3