org.apache.jetspeed.om.profile
クラス BasePSMLDocument

java.lang.Object
  拡張org.apache.jetspeed.om.profile.BasePSMLDocument
すべての実装インタフェース:
java.lang.Cloneable, PSMLDocument, java.io.Serializable

public class BasePSMLDocument
extends java.lang.Object
implements PSMLDocument

This class represents a loaded PSML document in memory, providing all facilities for finding and updating specific parts of the document.

バージョン:
$Id: BasePSMLDocument.java,v 1.9 2004/02/23 03:05:01 jford Exp $
作成者:
Rapha?l Luta
関連項目:
直列化された形式

コンストラクタの概要
BasePSMLDocument()
          Construct a new empty PSMLDocument
BasePSMLDocument(java.lang.String name, Portlets portlets)
          Construct a new named PSMLDocument associated with the specified PSML portlet set description
 
メソッドの概要
 java.lang.Object clone()
          Create a clone of this object
static Entry getEntry(Portlets portlets, java.lang.String name)
          Returns the first entry in the specified PSML resource corresponding to the given portlet name
 Entry getEntry(java.lang.String name)
          Returns the first entry in the current PSML resource corresponding to the given portlet name
static Entry getEntryById(Portlets portlets, java.lang.String entryId)
          Returns the first entry in the specified PSML resource corresponding to the given portlet Id
 Entry getEntryById(java.lang.String entryId)
          Returns the first entry in the current PSML resource corresponding to the given entry id
 java.lang.String getName()
          Return the name of this document
 Portlets getPortlets()
          Return ths portlet set PSML description of this document
 Portlets getPortlets(int position)
          Returns the first portlets element in the current PSML resource found at the specified position.
static Portlets getPortlets(Portlets portlets, int position, int count)
          Returns the first portlets element in the specified PSML resource in the given position
static Portlets getPortlets(Portlets portlets, java.lang.String name)
          Returns the first portlets element in the specified PSML resource corresponding to the given name
 Portlets getPortlets(java.lang.String name)
          Returns the first portlets element in the current PSML resource corresponding to the given name
static Portlets getPortletsById(Portlets portlets, java.lang.String portletId)
          Returns the first portlets element in the specified PSML resource corresponding to the given Id
 Portlets getPortletsById(java.lang.String portletId)
          Returns the first portlets element in the current PSML resource corresponding to the given id
static boolean removeEntryById(Portlets portlets, java.lang.String entryId)
          Remove the Entry in the specified PSML resource corresponding to the given portlet Id
 boolean removeEntryById(java.lang.String entryId)
          Remove the Entry in the specified PSML resource corresponding to the given portlet Id
 void setName(java.lang.String name)
          Sets a new name for this document
 void setPortlets(Portlets portlets)
          Sets a new PSML object model for this document
 
クラス java.lang.Object から継承したメソッド
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

BasePSMLDocument

public BasePSMLDocument()
Construct a new empty PSMLDocument


BasePSMLDocument

public BasePSMLDocument(java.lang.String name,
                        Portlets portlets)
Construct a new named PSMLDocument associated with the specified PSML portlet set description

パラメータ:
name - the name of this document
portlets - the PSML memory structure
メソッドの詳細

getName

public final java.lang.String getName()
Return the name of this document

定義:
インタフェース PSMLDocument 内の getName

setName

public final void setName(java.lang.String name)
Sets a new name for this document

定義:
インタフェース PSMLDocument 内の setName
パラメータ:
name - the new document name

getPortlets

public final Portlets getPortlets()
Return ths portlet set PSML description of this document

定義:
インタフェース PSMLDocument 内の getPortlets
戻り値:
a PSML object model hierarchy, or null if none is defined for this document

setPortlets

public final void setPortlets(Portlets portlets)
Sets a new PSML object model for this document

定義:
インタフェース PSMLDocument 内の setPortlets
パラメータ:
portlets - the PSML object model

getEntry

public Entry getEntry(java.lang.String name)
Returns the first entry in the current PSML resource corresponding to the given portlet name

定義:
インタフェース PSMLDocument 内の getEntry
パラメータ:
name - the portlet name to seek
戻り値:
the found entry description or null

getEntryById

public Entry getEntryById(java.lang.String entryId)
Returns the first entry in the current PSML resource corresponding to the given entry id

定義:
インタフェース PSMLDocument 内の getEntryById
パラメータ:
entryId - the portlet's entry id to seek
戻り値:
the found entry description or null

getPortlets

public Portlets getPortlets(java.lang.String name)
Returns the first portlets element in the current PSML resource corresponding to the given name

定義:
インタフェース PSMLDocument 内の getPortlets
パラメータ:
name - the portlets name to seek
戻り値:
the found portlets description or null

getPortletsById

public Portlets getPortletsById(java.lang.String portletId)
Returns the first portlets element in the current PSML resource corresponding to the given id

定義:
インタフェース PSMLDocument 内の getPortletsById
パラメータ:
portletId - the portlet's entry id to seek
戻り値:
the found portlets description or null

getPortlets

public Portlets getPortlets(int position)
Returns the first portlets element in the current PSML resource found at the specified position. The position is computed using a left-most tree traversal algorithm of the existing portlets (thus not counting other entry objects)

定義:
インタフェース PSMLDocument 内の getPortlets
パラメータ:
position - the sought position
戻り値:
the found portlets object or null if we did not find such an object

getEntry

public static Entry getEntry(Portlets portlets,
                             java.lang.String name)
Returns the first entry in the specified PSML resource corresponding to the given portlet name

パラメータ:
portlets - the PSML description to look into
name - the portlet name to seek
戻り値:
the found entry description or null

getEntryById

public static Entry getEntryById(Portlets portlets,
                                 java.lang.String entryId)
Returns the first entry in the specified PSML resource corresponding to the given portlet Id

パラメータ:
portlets - the PSML description to look into
entryId - the portlet's entry id to seek
戻り値:
the found entry description or null

getPortletsById

public static Portlets getPortletsById(Portlets portlets,
                                       java.lang.String portletId)
Returns the first portlets element in the specified PSML resource corresponding to the given Id

パラメータ:
portlets - the PSML description to look into
portletId - the portlet's id to seek
戻り値:
the found portlets description or null

getPortlets

public static Portlets getPortlets(Portlets portlets,
                                   java.lang.String name)
Returns the first portlets element in the specified PSML resource corresponding to the given name

パラメータ:
portlets - the PSML description to look into
name - the portlets name to seek
戻り値:
the found portlets description or null

getPortlets

public static Portlets getPortlets(Portlets portlets,
                                   int position,
                                   int count)
Returns the first portlets element in the specified PSML resource in the given position

パラメータ:
portlets - the PSML description to look into
position - the position to look for
count - the numbering for the portlets passed as parameter
戻り値:
the found portlets description or null

removeEntryById

public boolean removeEntryById(java.lang.String entryId)
Remove the Entry in the specified PSML resource corresponding to the given portlet Id

定義:
インタフェース PSMLDocument 内の removeEntryById
パラメータ:
entryId - the portlet's entry id to seek
戻り値:
true if the entry was removed

removeEntryById

public static boolean removeEntryById(Portlets portlets,
                                      java.lang.String entryId)
Remove the Entry in the specified PSML resource corresponding to the given portlet Id

パラメータ:
portlets - the PSML description to look into
entryId - the portlet's entry id to seek

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Create a clone of this object

定義:
インタフェース PSMLDocument 内の clone
例外:
java.lang.CloneNotSupportedException


Copyright © 2002-2006 SourceForge.jp - Jetspeed日本語版. All Rights Reserved.