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

The slice configuration checks and accesses a ConfigHolder for a slice, which has to consist (at least) of the following fields:
size - the maximal size of the slice
termination - the termination time of the slice as number representing standard base time. More...

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

List of all members.

Public Member Functions
	SliceConfiguration ()
	The standard constuructor.
	SliceConfiguration (final long size, final long termination)
	Constructs a SliceConfiguration.
	SliceConfiguration (final long size, final DateTime termination)
	Constructs a SliceConfiguration.
final boolean	isValid ()
final long	getSize ()
	Returns the size of a slice configuration.
final void	setSize (final long size)
	Sets the size of a slice configuration.
final DateTime	getTerminationTime ()
	Returns the termination time of a slice configuration as DateTime.
final long	getTerminationTimeAsLong ()
	Returns the termination time of a slice configuration as long value.
final void	setTerminationTime (final DateTime terminationTime)
	Sets the termination time of a slice configuration as DateTime.
final void	setTerminationTime (final long termination)
	Sets the termination time of a slice configuration as long value.
final String	getStringRepresentation ()
final String	toString ()
final boolean	equals (final Object obj)
final int	hashCode ()
Static Public Member Functions
static SliceConfiguration	checkSliceConfig (final Configuration config)
	Converts a Configuration into a SliceConfiguration, if possible, and returns it, if valid.
static SliceConfiguration	getSliceConfiguration (Slice slice)
	Returns the slice configuration of a given slice.
Static Public Attributes
static final String	SLICE_SIZE = "sliceSize"
	The key for the slice's size.
static final String	TERMINATION_TIME = "terminationTime"
	The key for the slice's DEADLINE time.
Private Attributes
long	size
	The maximum size of the slice.
DateTime	terminationTime
	The termination time of the slice.

---

Detailed Description

The slice configuration checks and accesses a ConfigHolder for a slice, which has to consist (at least) of the following fields:
size - the maximal size of the slice
termination - the termination time of the slice as number representing standard base time.

Author:

Ulrike Golas

---

Constructor & Destructor Documentation

de.zib.gndms.logic.model.dspace.SliceConfiguration.SliceConfiguration

(

)

The standard constuructor.

To construct standard instances

                                {

    }

de.zib.gndms.logic.model.dspace.SliceConfiguration.SliceConfiguration	(	final long	size,
		final long	termination
	)

Constructs a SliceConfiguration.

Parameters:

size	The maximum size.
termination	The termination time.

                                                {
                this.size = size;
                setTerminationTime(termination);
        }

de.zib.gndms.logic.model.dspace.SliceConfiguration.SliceConfiguration	(	final long	size,
		final DateTime	termination
	)

Constructs a SliceConfiguration.

Parameters:

size	The maximum size.
termination	The termination time.

                                                                               {
                this.size = size;
                this.terminationTime = termination;
        }

---

Member Function Documentation

static SliceConfiguration de.zib.gndms.logic.model.dspace.SliceConfiguration.checkSliceConfig

(

final Configuration

config

)

[static]

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

Parameters:

config

The given configuration.

Returns:

The valid SliceConfiguration.

                                                                                      {
                try {
                        SliceConfiguration sliceConfig = (SliceConfiguration) config;
                        if (sliceConfig.isValid()) {
                                return sliceConfig;
                        } else {
                                throw new WrongConfigurationException(
                                                "Wrong slice configuration");
                        }
                } catch (ClassCastException e) {
                        throw new WrongConfigurationException(
                                        "Wrong slice configuration");
                }
        }

final long de.zib.gndms.logic.model.dspace.SliceConfiguration.getSize

(

)

Returns the size of a slice configuration.

Returns:

The size.

                                    {
                return size;
        }

static SliceConfiguration de.zib.gndms.logic.model.dspace.SliceConfiguration.getSliceConfiguration

(

Slice

slice

)

[static]

Returns the slice configuration of a given slice.

Parameters:

slice

The slice.

Returns:

The slice configuration.

                                                                            {
                return new SliceConfiguration(slice.getTotalStorageSize(), slice.getTerminationTime());
        }

final DateTime de.zib.gndms.logic.model.dspace.SliceConfiguration.getTerminationTime

(

)

Returns the termination time of a slice configuration as DateTime.

Returns:

The termination time.

                                                   {
                return terminationTime;
        }

final long de.zib.gndms.logic.model.dspace.SliceConfiguration.getTerminationTimeAsLong

(

)

Returns the termination time of a slice configuration as long value.

Returns:

The termination time.

                                                     {
                return terminationTime.getMillis();
        }

final void de.zib.gndms.logic.model.dspace.SliceConfiguration.setSize

(

final long

size

)

Sets the size of a slice configuration.

Parameters:

size

The size.

                                                   {
                this.size = size;
        }

final void de.zib.gndms.logic.model.dspace.SliceConfiguration.setTerminationTime

(

final long

termination

)

Sets the termination time of a slice configuration as long value.

Parameters:

termination

The termination time.

                                                                     {
                terminationTime = new DateTime().plus( termination );
        }

final void de.zib.gndms.logic.model.dspace.SliceConfiguration.setTerminationTime

(

final DateTime

terminationTime

)

Sets the termination time of a slice configuration as DateTime.

Parameters:

terminationTime

The termination time.

                                                                             {
                this.terminationTime = terminationTime;
        }

---

The documentation for this class was generated from the following file:

• logic/src/de/zib/gndms/logic/model/dspace/SliceConfiguration.java