Copyright © 2011 Citra Technologies. All Rights Reserved.

com.citra.pivot.olap.metadata.impl
Class AbstractOlapObject

java.lang.Object
  extended by com.citra.pivot.olap.metadata.impl.AbstractOlapObject
All Implemented Interfaces:
OlapObject
Direct Known Subclasses:
OlapCubeImpl, OlapDimensionImpl, OlapHierarchyImpl, OlapLevelImpl, OlapMemberImpl, OlapSchemaImpl

public abstract class AbstractOlapObject
extends Object
implements OlapObject

AbstractOlapObject is the base abstract class for all modifiable metadata olap objects.


Field Summary
protected  String caption
          the object's caption
protected  String description
          the object's description
protected  String id
          the object's id
protected  String name
          the object's name
 
Constructor Summary
protected AbstractOlapObject(String name)
          Constructs an AbstractOlapObject.
protected AbstractOlapObject(String name, String id)
          Constructs an AbstractOlapObject.
protected AbstractOlapObject(String name, String id, String caption)
          Constructs an AbstractOlapObject.
protected AbstractOlapObject(String name, String id, String caption, String description)
          Constructs an AbstractOlapObject.
 
Method Summary
 String getCaption()
          Retrieves the caption of the olap object.
 String getDescription()
          Retrieves the description of the olap object.
 String getID()
          Retrieves the id of the olap object.
 String getName()
          Retrieves the name of the olap object.
 void setCaption(String caption)
          Assigns the caption.
 void setDescription(String description)
          Assigns the description.
 void setID(String id)
          Assigns the object's id.
 void setName(String name)
          Assigns the object's name.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

protected String name
the object's name


id

protected String id
the object's id


description

protected String description
the object's description


caption

protected String caption
the object's caption

Constructor Detail

AbstractOlapObject

protected AbstractOlapObject(String name)
Constructs an AbstractOlapObject.


AbstractOlapObject

protected AbstractOlapObject(String name,
                             String id)
Constructs an AbstractOlapObject.


AbstractOlapObject

protected AbstractOlapObject(String name,
                             String id,
                             String caption)
Constructs an AbstractOlapObject.


AbstractOlapObject

protected AbstractOlapObject(String name,
                             String id,
                             String caption,
                             String description)
Constructs an AbstractOlapObject.

Method Detail

getCaption

public String getCaption()
Retrieves the caption of the olap object.

Specified by:
getCaption in interface OlapObject
Returns:
the caption as string

getDescription

public String getDescription()
Retrieves the description of the olap object.

Specified by:
getDescription in interface OlapObject
Returns:
the description as string

getID

public String getID()
Retrieves the id of the olap object.

Specified by:
getID in interface OlapObject
Returns:
the id as string

getName

public String getName()
Retrieves the name of the olap object.

Specified by:
getName in interface OlapObject
Returns:
the name as string

setCaption

public void setCaption(String caption)
Assigns the caption.

Parameters:
caption - the caption to assign

setDescription

public void setDescription(String description)
Assigns the description.

Parameters:
description - the description to assign

setID

public void setID(String id)
Assigns the object's id.

Parameters:
id - the id to assign

setName

public void setName(String name)
Assigns the object's name.

Parameters:
name - the name to assign

Copyright © 2011 Citra Technologies. All Rights Reserved.