org.bibalex.daf.entities
Class CollectionEntities

java.lang.Object
  org.bibalex.daf.entities.CollectionEntities

Direct Known Subclasses:

InCharge, Owner, Project

public abstract class CollectionEntities
extends java.lang.Object

This class is used by the Collection Entities like Owner, Project and In-Charge. It unifies the way the collection treats its different composing entities.

Author:

Fadi.Edward

Field Summary

protected java.lang.String	abbreviation
protected java.lang.String	comment
protected int	id
protected java.lang.String	name

Constructor Summary

CollectionEntities()

Method Summary

java.lang.String	getAbbreviation() Most Entities have abbreviation, if this is not appplicable, return ""
java.lang.String	getComment() If the Entity supports a comment field, it should be returned by this method.
int	getID() Retrieves the ID of the Entity (Usually it is always an unsigned int)
java.lang.String	getName() Each entity has at least a name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

protected int id

name

protected java.lang.String name

abbreviation

protected java.lang.String abbreviation

comment

protected java.lang.String comment

Constructor Detail

CollectionEntities

public CollectionEntities()

Method Detail

getID

public int getID()

Retrieves the ID of the Entity (Usually it is always an unsigned int)

Returns:

The ID of the Entity

getName

public java.lang.String getName()

Each entity has at least a name.

Returns:

The Name of the Entity.

getAbbreviation

public java.lang.String getAbbreviation()

Most Entities have abbreviation, if this is not appplicable, return ""

Returns:

The Abbreviation of the given Entity, Abbreviations are usually 3 or 4 characters long.

getComment

public java.lang.String getComment()

If the Entity supports a comment field, it should be returned by this method.

Returns:

The comment of the Entity if applicable, "" otherwise.