de.lmu.ifi.dbs.elki.persistent
Class AbstractPage<P extends AbstractPage<P>>

java.lang.Object
  de.lmu.ifi.dbs.elki.persistent.AbstractPage<P>

Type Parameters:

P - Self reference

All Implemented Interfaces:

Page<P>, Externalizable, Serializable

Direct Known Subclasses:

AbstractNode

public abstract class AbstractPage<P extends AbstractPage<P>>
extends Object
implements Page<P>

Abstract superclass for pages.

Author:

Elke Achtert

See Also:

Serialized Form

Field Summary

private boolean	dirty The dirty flag of this page.
private PageFile<P>	file The file that stores the pages.
private Integer	id The unique id if this page.
private static long	serialVersionUID

Constructor Summary

AbstractPage()
Empty constructor for Externalizable interface.

AbstractPage(PageFile<P> file)
Provides a new page object.

Method Summary

boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
PageFile<P>	getFile() Returns the file that stores the pages.
Integer	getID() Returns the unique id of this Page.
int	hashCode() Returns as hash code value for this node the id of this node.
boolean	isDirty() Returns true if this page is dirty, false otherwise.
void	readExternal(ObjectInput in) The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays.
void	setDirty(boolean dirty) Sets the dirty flag of this page.
void	setFile(PageFile<P> file) Sets the page file of this page.
void	setID(int id) Sets the unique id of this Page.
String	toString() Returns a string representation of the object.
void	writeExternal(ObjectOutput out) The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

id

private Integer id

The unique id if this page.

dirty

private boolean dirty

The dirty flag of this page.

file

private PageFile<P extends AbstractPage<P>> file

The file that stores the pages.

Constructor Detail

AbstractPage

public AbstractPage()

Empty constructor for Externalizable interface.

AbstractPage

public AbstractPage(PageFile<P> file)

Provides a new page object.

Parameters:

file - the page file that stores the pages.

Method Detail

getID

public final Integer getID()

Returns the unique id of this Page.

Specified by:

getID in interface Page<P extends AbstractPage<P>>

Returns:

the unique id of this Page

setID

public final void setID(int id)

Sets the unique id of this Page.

Specified by:

setID in interface Page<P extends AbstractPage<P>>

Parameters:

id - the id to be set

setFile

public final void setFile(PageFile<P> file)

Sets the page file of this page.

Specified by:

setFile in interface Page<P extends AbstractPage<P>>

Parameters:

file - the page file to be set

isDirty

public final boolean isDirty()

Returns true if this page is dirty, false otherwise.

Specified by:

isDirty in interface Page<P extends AbstractPage<P>>

Returns:

true if this page is dirty, false otherwise

setDirty

public final void setDirty(boolean dirty)

Sets the dirty flag of this page.

Specified by:

setDirty in interface Page<P extends AbstractPage<P>>

Parameters:

dirty - the dirty flag to be set

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Specified by:

writeExternal in interface Externalizable

Parameters:

out - the stream to write the object to

Throws:

IOException - Includes any I/O exceptions that may occur

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.

Specified by:

readExternal in interface Externalizable

Parameters:

in - the stream to read data from in order to restore the object

Throws:

IOException - if I/O errors occur

ClassNotFoundException - If the class for an object being restored cannot be found.

toString

public String toString()

Returns a string representation of the object.

Overrides:

toString in class Object

Returns:

a string representation of the object

getFile

public final PageFile<P> getFile()

Returns the file that stores the pages.

Returns:

the file that stores the pages

equals

public boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class Object

Parameters:

o - the object to be tested

Returns:

true, if o is an AbstractNode and has the same id and the same entries as this node.

hashCode

public int hashCode()

Returns as hash code value for this node the id of this node.

Overrides:

hashCode in class Object

Returns:

the id of this node