org.mpxj.mpp

Class AbstractView

java.lang.Object

org.mpxj.mpp.AbstractView

All Implemented Interfaces:

View

Direct Known Subclasses:

AbstractMppView

public abstract class AbstractView
extends Object
implements View

This abstract class implements functionality common to all views.

Field Summary

Fields

Modifier and Type	Field and Description
protected ProjectFile	m_file
protected Integer	m_id
protected String	m_name
protected String	m_tableName
protected TableContainer	m_tables
protected ViewType	m_type

Constructor Summary

Constructors

Constructor and Description
AbstractView(ProjectFile parent) Constructor.

Method Summary

Modifier and Type	Method and Description
Integer	getID() This method is used to retrieve the unique view identifier.
String	getName() This method is used to retrieve the view name.
Table	getTable() Retrieve an instance of the Table class representing the table part of this view.
String	getTableName() Retrieve the name of the table part of the view.
ViewType	getType() Retrieves the view type.
String	toString() This method dumps the contents of this View as a String.

Methods inherited from class java.lang.Object

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

Field Detail

m_file

protected final ProjectFile m_file

m_tables

protected final TableContainer m_tables

m_id

protected Integer m_id

m_name

protected String m_name

m_type

protected ViewType m_type

m_tableName

protected String m_tableName

Constructor Detail

AbstractView

public AbstractView(ProjectFile parent)

Constructor.

Parameters:

parent - parent file

Method Detail

getID

public Integer getID()

Description copied from interface: View

This method is used to retrieve the unique view identifier. This value identifies the view within the file. It does not identify the type of view represented by an instance of this class.

Specified by:

getID in interface View

Returns:

view identifier

getName

public String getName()

Description copied from interface: View

This method is used to retrieve the view name. Note that internally in MS Project the view name will contain an ampersand (&) used to flag the letter that can be used as a shortcut for this view. The ampersand is stripped out by MPXJ.

Specified by:

getName in interface View

Returns:

view name

getType

public ViewType getType()

Description copied from interface: View

Retrieves the view type.

Specified by:

getType in interface View

Returns:

view type

getTableName

public String getTableName()

Retrieve the name of the table part of the view.

Specified by:

getTableName in interface View

Returns:

table name

getTable

public Table getTable()

Retrieve an instance of the Table class representing the table part of this view.

Specified by:

getTable in interface View

Returns:

table instance

toString

public String toString()

This method dumps the contents of this View as a String. Note that this facility is provided as a debugging aid.

Overrides:

toString in class Object

Returns:

formatted contents of this view