Copyright © 2011 Citra Technologies. All Rights Reserved.

com.citra.pivot.table
Class AbstractTableObject

java.lang.Object
  extended by com.citra.pivot.table.AbstractTableObject
All Implemented Interfaces:
OlapObject
Direct Known Subclasses:
TableCube, TableDimension, TableHierarchy, TableLevel, TableMember, TableSchema

public abstract class AbstractTableObject
extends Object
implements OlapObject

AbstractTableObject is the base abstract class for all table metadata olap objects.


Field Summary
protected  String caption
          the object's default caption
protected  String description
          the object's default description
protected  String id
          the object's id
protected  String name
          the object's name
 
Constructor Summary
protected AbstractTableObject(String name)
          Constructs a AbstractTableObject.
protected AbstractTableObject(String name, String id)
          Constructs a AbstractTableObject.
protected AbstractTableObject(String name, String id, String caption)
          Constructs a AbstractTableObject.
protected AbstractTableObject(String name, String id, String caption, String description)
          Constructs a AbstractTableObject.
 
Method Summary
 String getCaption()
          Retrieves the caption of the olap object.
 String getCaption(Locale locale)
          Returns a caption with a given locale.
 String getDescription()
          Retrieves the description of the olap object.
 String getDescription(Locale locale)
          Returns a description with a given locale.
 String getID()
          Retrieves the id of the olap object.
 String getName()
          Retrieves the name of the olap object.
 void setCaption(Locale locale, String caption)
          Assigns the caption for the given locale.
 void setCaption(String caption)
          Assigns the default caption.
 void setDescription(Locale locale, String description)
          Assigns the description for the given locale.
 void setDescription(String description)
          Assigns the default description.
 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 default description


caption

protected String caption
the object's default caption

Constructor Detail

AbstractTableObject

protected AbstractTableObject(String name)
Constructs a AbstractTableObject.


AbstractTableObject

protected AbstractTableObject(String name,
                              String id)
Constructs a AbstractTableObject.


AbstractTableObject

protected AbstractTableObject(String name,
                              String id,
                              String caption)
Constructs a AbstractTableObject.


AbstractTableObject

protected AbstractTableObject(String name,
                              String id,
                              String caption,
                              String description)
Constructs a AbstractTableObject.

Method Detail

getCaption

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

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

getCaption

public String getCaption(Locale locale)
Returns a caption with a given locale.

Parameters:
locale - the locale for which a caption is returned
Returns:
the object's caption

getDescription

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

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

getDescription

public String getDescription(Locale locale)
Returns a description with a given locale.

Parameters:
locale - the locale for which a description is returned
Returns:
the object's description

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 default caption.

Parameters:
caption - the caption to assign

setCaption

public void setCaption(Locale locale,
                       String caption)
Assigns the caption for the given locale.

Parameters:
locale - the locale for which a caption is assigned
caption - the caption to assign

setDescription

public void setDescription(String description)
Assigns the default description.

Parameters:
description - the description to assign

setDescription

public void setDescription(Locale locale,
                           String description)
Assigns the description for the given locale.

Parameters:
locale - the locale for which a description is assigned
description - the description 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.