MPXJ: Microsoft Project Exchange

net.sf.mpxj
Class AbstractView

java.lang.Object
  net.sf.mpxj.AbstractView

All Implemented Interfaces:

View

Direct Known Subclasses:

AbstractMppView

public abstract class AbstractView
extends java.lang.Object
implements View

This abstract class implements functionality common to all views.

Field Summary

protected java.lang.Integer	m_id
protected java.lang.String	m_name
protected ViewType	m_type

Constructor Summary

AbstractView()

Method Summary

java.lang.Integer	getID() This method is used to retrieve the unique view identifier.
java.lang.String	getName() This method is used to retrieve the view name.
ViewType	getType() Retrieves the view type.
java.lang.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_id

protected java.lang.Integer m_id

m_name

protected java.lang.String m_name

m_type

protected ViewType m_type

Constructor Detail

AbstractView

public AbstractView()

Method Detail

getID

public java.lang.Integer getID()

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 java.lang.String getName()

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()

Retrieves the view type.

Specified by:

getType in interface View

Returns:

view type

toString

public java.lang.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 java.lang.Object

Returns:

formatted contents of this view