| java.lang.Object
 org.openharmonise.rm.resources.AbstractObject
org.openharmonise.rm.resources.AbstractEditableObject
org.openharmonise.rm.resources.AbstractProfiledObject
org.openharmonise.rm.resources.AbstractChildObject
All known Subclasses: org.openharmonise.rm.resources.publishing.WebPage, org.openharmonise.rm.resources.content.Asset, org.openharmonise.rm.resources.metadata.properties.Property, org.openharmonise.rm.resources.AbstractParentObject, org.openharmonise.rm.resources.users.User, org.openharmonise.rm.resources.metadata.values.Value, org.openharmonise.rm.resources.content.TextResource,
| Method Summary | |
| protected void | addColumnsToPopulateQuery(SelectStatement select, boolean bIsHist)
| | protected void | addDataToSave(InsertStatement insert)
| | protected void | addParent(AbstractParentObject group)
| | public Editable | archive()
| | public Editable | changeStatus(Status status)
| | public void | clear()
| | public Object | clone()
| | protected AbstractParentObject | createGroupFromPath(String sFullPath)
Creates an AbstractParentObject from the specified path. | | protected void | delete(boolean bDeleteHist)
| | protected void | fullPopulate()
| | public List | getAllFullPaths()
Returns a list of all possible full paths for this child. | | public List | getAllPaths()
Returns a list of of all the paths to this child object. | | public static ColumnRef | getColumnRef(String sClassname, String sColumn, boolean bHist)
| | public String | getFullPath()
Returns the complete path string, which includes the name of this
object, which specifies the default location in the hierarchy of
parent-child relationships of this object. | | public ColumnRef | getInstanceColumnRef(String sColumn, boolean bIsHist)
| | public static ColumnRef | getObjectColumnRef(String sTable, String sColumn)
| | protected ColumnRef | getParentChildJoinColumnRef(String sCol)
Returns the column reference for a column in the parent-child
relationship table. | | abstract public String | getParentObjectClassName()
Returns the name of the class that may act as parent to this object. | | public static String | getParentObjectClassName(String sChildClassname)
Returns the class name of parent object for the given
child object of type sChildClassname. | | public List | getParents()
Returns a list of all this child's parent objects. | | public String | getPath()
Returns the path string which specifies the default location in the
hierarchy of parent-child relationships of this object. | | public AbstractParentObject | getRealParent()
Returns the 'real' parent of this child object. | | public boolean | isChanged()
| | public boolean | isRealParent(AbstractParentObject obj)
Returns true if the specified AbstractParentObject
is the 'real' parent of this child object. | | public void | markAsNew()
| | public void | populate(Element xmlElement, State state)
| | protected void | populateFromResultSetRow(ResultSet rs, SelectStatement select)
| | protected void | populateGroupsFromDatabase()
Populates this object's store of parents from database. | | public org.w3c.dom.Element | publish(Element topEl, HarmoniseOutput xmlDoc, State state)
| | public Editable | reactivate()
| | protected void | removeParent(AbstractParentObject group)
Removes the specified parent object from this child's list of parents. | | protected void | saveCoreData()
| | protected void | setRealParent(AbstractParentObject group)
Adds and sets the given parent object as the 'real'/default
parent of this child object. | | protected void | update()
| | protected void | updateParents()
Updates all parents if this child object has added itself
to any parent objects, only necessary if populate
has been called. |
| ARCHIVE_TIMESTAMP_FORMAT | | final public static String ARCHIVE_TIMESTAMP_FORMAT(Code) | | Archive timestamp format, used in composing archived child names in
the case of a duplicate name
|
| ATTRIB_DEFAULT | | final public static String ATTRIB_DEFAULT(Code) | | Name of XML attribute which specifies whether a parent object is the
default parent
|
| ATTRIB_SHOWALL | | final public static String ATTRIB_SHOWALL(Code) | | Name of XML attribute which determines whether all parent objects
should be published
|
| CLMN_CHILD_KEY | | final protected static String CLMN_CHILD_KEY(Code) | | Relationship table child key column name
|
| CLMN_DATE | | final protected static String CLMN_DATE(Code) | | Relationship table date column name
|
| CLMN_DEFAULT_LINK | | final protected static String CLMN_DEFAULT_LINK(Code) | | Relationship table default link column name
|
| CLMN_PARENT_KEY | | final protected static String CLMN_PARENT_KEY(Code) | | Relationship table parent key column name
|
| CLMN_PATH | | final protected static String CLMN_PATH(Code) | | Relationship table path column name
|
| IS_DEFAULT_GROUP | | final protected static String IS_DEFAULT_GROUP(Code) | | Constant value for default attribute when insantiating object
with XML, specifically this value indicates that the parent
object should be added as the default parent
|
| JOIN_TO | | final public static String JOIN_TO(Code) | | String used for composing relationship table names.
Note: the pattern for relationship table names is
'parentObj.getTableName() + JOIN_TO + childObj.getTableName()'
|
| TAG_GROUP | | final public static String TAG_GROUP(Code) | | Group tag name
|
| TAG_PATH | | final public static String TAG_PATH(Code) | | Path tag name
|
| m_bIsGroupsPopulated | | protected boolean m_bIsGroupsPopulated(Code) | | The boolean flag which indicates whether this object has
populated it's Map of parents
|
| m_child_parent_mappings | | protected static Map m_child_parent_mappings(Code) | | Map of child class to parent classes. Used to cache info.
|
| m_defaultGroup | | protected int m_defaultGroup(Code) | | The identifier of the default parent
|
| m_groups | | protected Map m_groups(Code) | | Map of parents of this child object
|
| m_groups_to_save | | protected List m_groups_to_save(Code) | | The list of parent objects to save on the next save()
operation
|
| m_sGroupClass | | protected String m_sGroupClass(Code) | | The name of the class that may act as parent to this object
|
| m_sPath | | protected String m_sPath(Code) | | The path of this object.
Note: this is only used if the object is historical, otherwise the
path is built on the fly from it's current relationships
|
| separator | | final public static String separator(Code) | | The Harmonise path-separator character
|
| AbstractChildObject | | public AbstractChildObject()(Code) | | Constructs a new or anonymous instance without an interface
to the database.
|
| AbstractChildObject | | public AbstractChildObject(AbstractDataStoreInterface dbintrf)(Code) | | Constructor for a new or anonymous instance.
Parameters:
dbintrf - the data store interface |
| AbstractChildObject | | public AbstractChildObject(AbstractDataStoreInterface dbintrf, int nId)(Code) | | Standard constructor for an existing resource,
registering an AbstractDataStoreInterface to use
with all database communications.
Parameters:
dbintrf - the interface to the database
Parameters:
nId - the id of the object |
| AbstractChildObject | | public AbstractChildObject(AbstractDataStoreInterface dbintrf, int nId, int nKey, boolean bIsHist)(Code) | | Standard constructor for an existing resource which may be historical.
Parameters:
dbintrf - the interface to the database
Parameters:
nId - the id of the object
Parameters:
nKey - the unique key of the resource
Parameters:
bIsHist - true if the object is historical |
| clear | | public void clear()(Code) | | |
| createGroupFromPath | | protected AbstractParentObject createGroupFromPath(String sFullPath) throws EditException(Code) | | Creates an AbstractParentObject from the specified path.
Parameters:
sFullPath - the path describing the location of the parent object the parent object
throws:
EditException - if an error occurs creating the object |
| getAllFullPaths | | public List getAllFullPaths() throws DataAccessException(Code) | | Returns a list of all possible full paths for this child.
a list of all possible full paths for this child
throws:
DataAccessException - if an error occurs building anyof the paths |
| getAllPaths | | public List getAllPaths() throws DataAccessException(Code) | | Returns a list of of all the paths to this child object.
a list of of all the paths to this child object
throws:
DataAccessException - if an error occurs building anyof the paths |
| getFullPath | | public String getFullPath() throws DataAccessException(Code) | | Returns the complete path string, which includes the name of this
object, which specifies the default location in the hierarchy of
parent-child relationships of this object.
the complete path string of this object
throws:
DataAccessException - if an error occurs getting the main pathinformation |
| getParentChildJoinColumnRef | | protected ColumnRef getParentChildJoinColumnRef(String sCol) throws DataStoreException(Code) | | Returns the column reference for a column in the parent-child
relationship table.
Parameters:
sCol - the column, tag or attribute name the corresponding column reference
throws:
DataStoreException - if an error occurs getting the column reference
throws:
InvalidColumnReferenceException - if the given column name isinvalid |
| getParentObjectClassName | | abstract public String getParentObjectClassName()(Code) | | Returns the name of the class that may act as parent to this object.
the name of the class that may act as parent to this object |
| getParentObjectClassName | | public static String getParentObjectClassName(String sChildClassname) throws DataAccessException(Code) | | Returns the class name of parent object for the given
child object of type sChildClassname.
Parameters:
sChildClassname - the child object class name the class name of parent object
throws:
DataAccessException - if an error occurs |
| getPath | | public String getPath() throws DataAccessException(Code) | | Returns the path string which specifies the default location in the
hierarchy of parent-child relationships of this object.
the path string which specifies the default location
throws:
DataAccessException - if an error occurs accessing the realparent |
| getRealParent | | public AbstractParentObject getRealParent() throws DataAccessException(Code) | | Returns the 'real' parent of this child object.
Note: Real can be understood to mean
the default or main parent of this child.
the 'real' parent of this child object.
throws:
DataAccessException - if an error occurs populating this objector accessing it's live version |
| isRealParent | | public boolean isRealParent(AbstractParentObject obj) throws DataAccessException(Code) | | Returns true if the specified AbstractParentObject
is the 'real' parent of this child object.
Parameters:
obj - the parent object true if the specified AbstractParentObject is the 'real' parent of this child object.
throws:
DataAccessException - if an error occurs accessing the real parent |
| populateGroupsFromDatabase | | protected void populateGroupsFromDatabase() throws PopulateException(Code) | | Populates this object's store of parents from database.
throws:
PopulateException - if an error occurs populating this object |
| removeParent | | protected void removeParent(AbstractParentObject group) throws PopulateException(Code) | | Removes the specified parent object from this child's list of parents.
Parameters:
group - the parent object to remove
throws:
PopulateException - if there is an erorr populating the list ofparent objects |
| setRealParent | | protected void setRealParent(AbstractParentObject group) throws PopulateException(Code) | | Adds and sets the given parent object as the 'real'/default
parent of this child object.
Parameters:
group - the default parent object
throws:
PopulateException - if there is an error adding this parent object |
| updateParents | | protected void updateParents() throws EditException(Code) | | Updates all parents if this child object has added itself
to any parent objects, only necessary if populate
has been called.
throws:
EditException - if an error occurs adding this child to a parent |
| Methods inherited from org.openharmonise.rm.resources.AbstractProfiledObject | protected void addColumnsToPopulateQuery(SelectStatement select, boolean bIsHist) throws DataStoreException(Code)(Java Doc)
public void addProfile(Profile profile) throws InvalidProfileException(Code)(Java Doc)
public Editable changeStatus(Status status) throws EditException(Code)(Java Doc)
public void clear()(Code)(Java Doc)
public Object clone()(Code)(Java Doc)
protected void delete(boolean bDeleteHistory) throws DataStoreException, DataAccessException, EditException, PopulateException(Code)(Java Doc)
protected void fillProfiles() throws PopulateException(Code)(Java Doc)
protected void fullPopulate() throws PopulateException(Code)(Java Doc)
public int getNumProfiles() throws DataAccessException(Code)(Java Doc)
public Profile getProfile() throws DataAccessException(Code)(Java Doc)
public Profile getProfile(String sName) throws DataAccessException(Code)(Java Doc)
public List getProfiles() throws DataAccessException(Code)(Java Doc)
public Map getProfilesMap() throws DataAccessException(Code)(Java Doc)
public AbstractPropertyInstance getPropertyInstance(String sPropName) throws InvalidPropertyInstanceException, DataAccessException(Code)(Java Doc)
public AbstractPropertyInstance getPropertyInstance(Property prop) throws InvalidPropertyInstanceException, DataAccessException(Code)(Java Doc)
public void ignoreProfileRestrictions(boolean bIgnore)(Code)(Java Doc)
public boolean isChanged() throws DataAccessException(Code)(Java Doc)
public boolean isDefaultProfile(Profile prof)(Code)(Java Doc)
protected boolean isProfileLoaded(String sName)(Code)(Java Doc)
public void markAsNew() throws PopulateException(Code)(Java Doc)
public void populate(Element xmlElement, State state) throws PopulateException(Code)(Java Doc)
protected void populateFromResultSetRow(ResultSet rs, SelectStatement select) throws PopulateException(Code)(Java Doc)
public List processResultSet(CachedResultSet rs, SelectStatement select)(Code)(Java Doc)
public List processResultSet(CachedResultSet rs, SelectStatement select, int nLimit)(Code)(Java Doc)
public Element publish(Element topEl, HarmoniseOutput xmlDoc, State state) throws PublishException(Code)(Java Doc)
public void removeProfile(String sProfile) throws DataAccessException(Code)(Java Doc)
protected void saveCoreData() throws EditException(Code)(Java Doc)
protected void setDefaultProfile(String sName) throws InvalidProfileException, DataAccessException(Code)(Java Doc)
public void setHistorical(boolean bIsHistorical)(Code)(Java Doc)
public void setProfile(Profile profile) throws InvalidProfileException(Code)(Java Doc)
protected void setProfiles(List profiles) throws InvalidProfileException(Code)(Java Doc)
protected void setProfiles(Map profiles)(Code)(Java Doc)
protected void setProfilesHistorical(boolean bIsHistorical)(Code)(Java Doc)
public String toString()(Code)(Java Doc)
protected void update() throws DataStoreException, EditException(Code)(Java Doc)
|
| Methods inherited from org.openharmonise.rm.resources.AbstractEditableObject | public void acquireEditWriteLock() throws EditException(Code)(Java Doc)
protected void addColumnsToPopulateQuery(SelectStatement select, boolean bIsHist) throws DataStoreException(Code)(Java Doc)
protected void addDataToSave(InsertStatement insert) throws DataStoreException(Code)(Java Doc)
public void addEditEventListener(EditEventListener listener)(Code)(Java Doc)
public Editable archive() throws EditException(Code)(Java Doc)
public Editable changeStatus(Status status) throws EditException(Code)(Java Doc)
public void clear()(Code)(Java Doc)
public Object clone()(Code)(Java Doc)
public Editable createNewVersion() throws EditException(Code)(Java Doc)
protected void delete(boolean bDeleteHist) throws DataStoreException, DataAccessException, EditException, PopulateException(Code)(Java Doc)
public List getAllVersions() throws DataAccessException(Code)(Java Doc)
public static ColumnRef getColumnRef(String sClassname, String sColumn, boolean bHist) throws DataStoreException(Code)(Java Doc)
public String getDisplayName() throws DataAccessException(Code)(Java Doc)
public List getHistoricalVersions() throws DataAccessException(Code)(Java Doc)
public java.util.Date getHistoryDate() throws DataAccessException(Code)(Java Doc)
public ColumnRef getInstanceColumnRef(String sColumn, boolean bIsHist) throws DataStoreException(Code)(Java Doc)
public Editable getLiveVersion() throws DataAccessException(Code)(Java Doc)
public User getLockOwner() throws DataAccessException(Code)(Java Doc)
public int getLockUserId() throws DataAccessException(Code)(Java Doc)
public static ColumnRef getObjectColumnRef(String sTable, String sColumn) throws DataStoreException(Code)(Java Doc)
public List getPendingVersions() throws DataAccessException(Code)(Java Doc)
public Status getStatus() throws DataAccessException(Code)(Java Doc)
public String getVersionComment() throws DataAccessException(Code)(Java Doc)
public java.util.Date getVersionDate() throws DataAccessException(Code)(Java Doc)
public int getVersionNumber() throws DataAccessException(Code)(Java Doc)
protected boolean isKeySupported()(Code)(Java Doc)
public boolean isLiveVersion() throws DataAccessException(Code)(Java Doc)
protected boolean isLockThread()(Code)(Java Doc)
public boolean isLocked() throws DataAccessException(Code)(Java Doc)
public boolean isPendingVersion() throws DataAccessException(Code)(Java Doc)
public synchronized void lock(User usr) throws EditException(Code)(Java Doc)
public void populate(Element xmlElement, State state) throws PopulateException(Code)(Java Doc)
protected void populateFromResultSetRow(ResultSet rs, SelectStatement select) throws PopulateException(Code)(Java Doc)
public Element publish(Element topEl, HarmoniseOutput xmlDoc, State state) throws PublishException(Code)(Java Doc)
public Editable reactivate() throws EditException(Code)(Java Doc)
public void releaseEditWriteLock()(Code)(Java Doc)
public void removeEditEventListener(EditEventListener listener)(Code)(Java Doc)
public Editable save() throws EditException(Code)(Java Doc)
abstract protected void saveCoreData() throws EditException(Code)(Java Doc)
abstract protected void saveNonCoreData() throws EditException(Code)(Java Doc)
public void setDisplayName(String sDisplayName)(Code)(Java Doc)
public void setVersionComment(String sVersionComment)(Code)(Java Doc)
public void unlock(User usr) throws EditException(Code)(Java Doc)
protected void update() throws DataStoreException, EditException(Code)(Java Doc)
protected void updateDBStatus() throws PopulateException(Code)(Java Doc)
public void workflowObjectArchived(EditEvent event)(Code)(Java Doc)
public void workflowObjectLocked(EditEvent event)(Code)(Java Doc)
public void workflowObjectReactivated(EditEvent event)(Code)(Java Doc)
public void workflowObjectSaved(EditEvent event)(Code)(Java Doc)
public void workflowObjectStatusChanged(EditEvent event)(Code)(Java Doc)
public void workflowObjectUnlocked(EditEvent event)(Code)(Java Doc)
|
| Methods inherited from org.openharmonise.rm.resources.AbstractObject | public void addCacheListener(CacheListener listener)(Code)(Java Doc)
protected void addColumnsToPopulateQuery(SelectStatement select, boolean bIsHist) throws DataStoreException(Code)(Java Doc)
public void clear()(Code)(Java Doc)
public Object clone()(Code)(Java Doc)
public int compareTo(Object obj)(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
public boolean exists()(Code)(Java Doc)
protected void fullPopulate() throws PopulateException(Code)(Java Doc)
public List getCacheListeners()(Code)(Java Doc)
public static ColumnRef getColumnRef(AbstractObject obj, String sColumn) throws DataStoreException(Code)(Java Doc)
public static ColumnRef getColumnRef(String sClassname, String sColumn) throws DataStoreException(Code)(Java Doc)
public static ColumnRef getColumnRef(String sClassname, String sColumn, boolean bHist) throws DataStoreException(Code)(Java Doc)
protected static Collection getCoreColumnRefs(String sClassname) throws DataStoreException(Code)(Java Doc)
abstract public String getDBTableName()(Code)(Java Doc)
public AbstractDataStoreInterface getDataStoreInterface()(Code)(Java Doc)
protected String getHistoricalDBTableName()(Code)(Java Doc)
public int getId()(Code)(Java Doc)
public ColumnRef getInstanceColumnRef(String sColumn, boolean bIsHist) throws DataStoreException(Code)(Java Doc)
public int getKey() throws DataAccessException(Code)(Java Doc)
public String getName() throws DataAccessException(Code)(Java Doc)
protected static ColumnRef getObjectColumnRef(String sDBTable, String sColumn) throws DataStoreException(Code)(Java Doc)
public String getSummary() throws DataAccessException(Code)(Java Doc)
public static String getTableName(String sClassname, boolean bHist) throws DataStoreException(Code)(Java Doc)
protected String getTableName(boolean bIsHist)(Code)(Java Doc)
public String getType() throws DataAccessException(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public boolean isChanged() throws DataAccessException(Code)(Java Doc)
public boolean isHistorical()(Code)(Java Doc)
abstract protected boolean isKeySupported()(Code)(Java Doc)
protected boolean isPopulated()(Code)(Java Doc)
protected void markAsNew() throws PopulateException(Code)(Java Doc)
public void notifyCacheListeners()(Code)(Java Doc)
public void populate(Element xmlElement, State state) throws PopulateException(Code)(Java Doc)
protected synchronized void populateFromDatabase() throws PopulateException(Code)(Java Doc)
protected void populateFromResultSetRow(ResultSet rs, SelectStatement select) throws PopulateException(Code)(Java Doc)
public Element publish(Template template, HarmoniseOutput xmlDoc, State state) throws PublishException(Code)(Java Doc)
public Element publish(Element topEl, HarmoniseOutput xmlDoc, State state) throws PublishException(Code)(Java Doc)
public void removeCacheListener(CacheListener listener)(Code)(Java Doc)
public void setDataStoreInterface(AbstractDataStoreInterface dsi) throws PopulateException(Code)(Java Doc)
public void setHistorical(boolean bIsHistorical)(Code)(Java Doc)
public void setId(int nId)(Code)(Java Doc)
public void setIsChanged(boolean bIsChanged)(Code)(Java Doc)
public void setKey(int nKey)(Code)(Java Doc)
public void setName(String sName) throws InvalidNameException(Code)(Java Doc)
public void setSummary(String sSummary)(Code)(Java Doc)
public void setType(String type)(Code)(Java Doc)
|
|
|