| java.lang.Object
 org.openharmonise.rm.resources.AbstractObject
org.openharmonise.rm.metadata.Profile
All known Subclasses: org.openharmonise.rm.security.authorization.AuthorityProfile, org.openharmonise.rm.metadata.ProfileValue, org.openharmonise.rm.workflow.WorkflowProfile,
| Method Summary | |
| protected void | addColumnsToPopulateQuery(SelectStatement select, boolean bIsHist)
| | public void | addPropertyInstance(AbstractPropertyInstance propInst)
Adds a property instance to this Profile. | | public Object | clone()
| | public void | delete()
Deletes this Profile from the database. | | public boolean | equals(Object obj)
| | public void | fillProfileData()
Populates the Profile data. | | public List | getAvailableProperties()
Returns the list of properties which can be added to this Profile, dependant
on the profiled object associated. | | public static ColumnRef | getColumnRef(AbstractProfiledObject profObj, String sColumn)
Returns the appropriate ColumnRef for the column of the
Profile for the given AbstractProfiledObject. | | public static ColumnRef | getColumnRef(String sClassname, String sColumn, boolean bHist)
Returns a column reference appropriate for the given
parameters. | | public String | getDBTableName()
| | public static String | getDBTableName(AbstractProfiledObject profObj)
Returns the database table name for the Profile of the
specified AbstractProfiledObject. | | public ColumnRef | getInstanceColumnRef(String sColumn, boolean bIsHist)
| | public JoinConditions | getInstanceJoinConditions(String sObjectTag, boolean bIsOuter)
| | public List | getMatchingPropertyInstances(List condProps)
Returns a List of AbstractPropertyInstances
whose defining Propertys have the given conditional
AbstractPropertyInstances in their Profile. | | protected AbstractProfiledObject | getProfiledObject()
Returns the AbstractProfiledObject associated with this
Profile. | | public AbstractPropertyInstance | getPropertyInstance(Property property)
Returns the instance of the given Property held by this
Profile if there is one. | | public AbstractPropertyInstance | getPropertyInstance(String sPropName)
Returns a instance of the Property with the specified
name if one exists in this Profile. | | public List | getPropertyInstances()
Returns the list of all property instances contained in this
Profile. | | public static String | getTableName(String sClassname, boolean bHist)
Returns the table name for the object of the class name given, taking account
for whether the historical table is needed or not. | | public String | getTagName()
| | public String | getVersionComment()
Returns the version comment for this Profile. | | public boolean | hasProperty(Property prop)
Returns true if the Profile has an instance of the
specified Property. | | public boolean | isChanged()
| | public boolean | isDefault()
Returns true if this Profile is the default
for its owning AbstractProfiledObject, otherwise false. | | public boolean | isHistorical()
| | protected boolean | isKeySupported()
| | public boolean | isNew()
Returns true if this Profile is new,
otherwise false. | | public boolean | isValid(AbstractProfiledObject profObj)
Returns true if this profile conforms to the restrictions
determined by the domains on the available properties. | | public boolean | isValidProperty(Property prop)
| | public boolean | isValidPropertyInstance(AbstractPropertyInstance propInst)
Returns true if the specified AbstractPropertyInstance
is valid for this Profile. | | public void | markAsNew()
| | public boolean | match(Profile prof)
Matches this Profile against the given Profile. | | public boolean | match(List propInstList)
Matches this Profile against the given Profile. | | public void | populate(Element xmlElement, State state)
| | protected synchronized void | populateChildObjectPropertyInstances(String sTableName)
Populates the ChildObjectPropertyInstances, of the type
specified by the class name given, held by this Profile. | | protected void | populateFromDatabase()
| | protected void | populateFromResultSetRow(ResultSet rs, SelectStatement select)
| | protected synchronized void | populateGeneralPropertyInstances()
Populates the GeneralPropertyInstances held by this
Profile. | | protected synchronized void | populateProfilePropertyInstances()
Populates the ProfilePropertyInstances held by this
Profile. | | protected void | populatePropertyInstancesFromDatabase()
Populates all the property instances in this Profile. | | public List | processResultSet(CachedResultSet resultSet, SelectStatement select)
| | public List | processResultSet(CachedResultSet resultSet, SelectStatement select, int limit)
| | public Element | publish(Element topEl, HarmoniseOutput xmlDoc, State state)
| | public void | removeProperty(Property prop)
Removes instances of the specified Property from this
Profile. | | public Profile | save(AbstractProfiledObject proObj)
Saves this Profile to the data store. | | public void | setHistorical(boolean bIsHistorical)
| | public void | setIsDefault(boolean bIsDefault)
Sets whether this Profile is the default for the owning
AbstractProfiledObject. | | public void | setProfiledObject(AbstractProfiledObject obj)
Sets the profiled object for this profile. | | public void | setVersionComment(String sComment)
Sets the version comment for this version of the Profile. | | public String | toString()
| | public void | update()
Updates the data in the database for this Profile. |
| ATTRIB_DEFAULT | | final public static String ATTRIB_DEFAULT(Code) | | 'default' XML attribute name
|
| ATTRIB_ISDEFAULT | | final public static String ATTRIB_ISDEFAULT(Code) | | 'Is default' XML attribute name
|
| ATTRIB_OBJECT_KEY | | final public static String ATTRIB_OBJECT_KEY(Code) | | Profiled object key XML attribute name
|
| EXT_PROFILE | | final protected static String EXT_PROFILE(Code) | | String constant extension used for building profile
database table name. The naming convention for Profile
database table names is as follows:
AbstractProfiledObject.getTableName() + EXT_PROFILE
|
| IS_DEFAULT_PROFILE_VALUE | | final public static String IS_DEFAULT_PROFILE_VALUE(Code) | | Value of ATTRIB_ISDEFAULT which indicates
that a Profile is default
|
| TAG_ALLPROPERTYINSTANCES | | final public static String TAG_ALLPROPERTYINSTANCES(Code) | | All property instance XML element name
|
| TAG_PROFILE | | final public static String TAG_PROFILE(Code) | | Profile XML element name
|
| TAG_PROPERTY_VALUE | | final public static String TAG_PROPERTY_VALUE(Code) | | Property value XML element name
|
| TEXT_MARKER | | final public static String TEXT_MARKER(Code) | | String constant to indicate temporary profiles
that will not be saved
|
| UNKNOWN_PROFILE | | final public static String UNKNOWN_PROFILE(Code) | | String constant used for unknown profiles
|
| m_sVersionComment | | protected String m_sVersionComment(Code) | | The version comment for this profile
|
| Profile | | public Profile()(Code) | | Constructs a Profile without an interface to the
data store.
|
| Profile | | public Profile(AbstractDataStoreInterface dbintrf)(Code) | | Constructs a Profile with an interface to the data store.
Parameters:
dbintrf - the data store interface |
| Profile | | public Profile(AbstractDataStoreInterface dbintrf, AbstractProfiledObject obj)(Code) | | Constructs a Profile which has an interface to the data store
and a reference to it's 'owner' AbstractProfiledObject.
Parameters:
dbintrf - the data store interface
Parameters:
obj - the 'owning' profiled object |
| Profile | | public Profile(AbstractDataStoreInterface dbintrf, int nId, AbstractProfiledObject obj)(Code) | | Constructs the Profile with the given id, a reference to it's
'owning' AbstractProfiledObject and an interface to the data
store.
Parameters:
dbintrf - the data store interface
Parameters:
nId - the profile id
Parameters:
obj - the 'owning' profiled object |
| addPropertyInstance | | public void addPropertyInstance(AbstractPropertyInstance propInst) throws ProfileException(Code) | | Adds a property instance to this Profile.
Parameters:
propInst - the property instance to add
throws:
ProfileException - if the given property instance is invalidor there is an error getting details from the property instance |
| getAvailableProperties | | public List getAvailableProperties() throws DataAccessException(Code) | | Returns the list of properties which can be added to this Profile, dependant
on the profiled object associated.
the list of properties which can be added to this Profile
throws:
DataAccessException - if |
| getColumnRef | | public static ColumnRef getColumnRef(AbstractProfiledObject profObj, String sColumn) throws DataStoreException(Code) | | Returns the appropriate ColumnRef for the column of the
Profile for the given AbstractProfiledObject.
Parameters:
profObj - the profiled object
Parameters:
sColumn - the column name the appropriate ColumnRef for the specified column
throws:
DataStoreException - if the specified column does not match anyvalid columns |
| getColumnRef | | public static ColumnRef getColumnRef(String sClassname, String sColumn, boolean bHist) throws DataStoreException(Code) | | Returns a column reference appropriate for the given
parameters.
Parameters:
sClassname - the class name of an AbstractObject
Parameters:
sColumn - the column, tag or attribute name
Parameters:
bHist - true if the column reference is associated with a historical object the column reference corresponding to the parameters
throws:
DataStoreException - if an error occurs |
| getDBTableName | | public static String getDBTableName(AbstractProfiledObject profObj)(Code) | | Returns the database table name for the Profile of the
specified AbstractProfiledObject.
Parameters:
profObj - the profiled object the database table name for the Profile of the specified AbstractProfiledObject |
| getMatchingPropertyInstances | | public List getMatchingPropertyInstances(List condProps) throws DataAccessException(Code) | | Returns a List of AbstractPropertyInstances
whose defining Propertys have the given conditional
AbstractPropertyInstances in their Profile.
Parameters:
condProps - |
| getProfiledObject | | protected AbstractProfiledObject getProfiledObject()(Code) | | Returns the AbstractProfiledObject associated with this
Profile.
|
| getPropertyInstances | | public List getPropertyInstances() throws DataAccessException(Code) | | Returns the list of all property instances contained in this
Profile.
the list of all property instances of the profile
throws:
DataAccessException - if an error occurs populating this profilefrom the database |
| getTableName | | public static String getTableName(String sClassname, boolean bHist) throws DataStoreException(Code) | | Returns the table name for the object of the class name given, taking account
for whether the historical table is needed or not.
Parameters:
sClassname - the class name of an AbstractObject
Parameters:
bHist - true if the table name is associated with a historical object the table name for the object
throws:
DataStoreException - if an error occurs |
| getVersionComment | | public String getVersionComment() throws DataAccessException(Code) | | Returns the version comment for this Profile.
the version comment for this Profile
throws:
DataAccessException - if an error occurs populating this profilefrom the database |
| hasProperty | | public boolean hasProperty(Property prop) throws DataAccessException(Code) | | Returns true if the Profile has an instance of the
specified Property.
Parameters:
prop - the Property
throws:
DataAccessException - if there is an error populating the propertyinstances of this Profile> |
| isDefault | | public boolean isDefault() throws DataAccessException(Code) | | Returns true if this Profile is the default
for its owning AbstractProfiledObject, otherwise false.
true if this Profile is the default
throws:
DataAccessException - if an error occurs populating this profilefrom the database |
| isHistorical | | public boolean isHistorical()(Code) | | |
| isKeySupported | | protected boolean isKeySupported()(Code) | | |
| isNew | | public boolean isNew()(Code) | | Returns true if this Profile is new,
otherwise false.
true if this Profile is new |
| isValid | | public boolean isValid(AbstractProfiledObject profObj) throws DataAccessException(Code) | | Returns true if this profile conforms to the restrictions
determined by the domains on the available properties.
true if this profile conforms to the restrictions determined by the domains on the available properties.
throws:
DataAccessException - if any errors occur getting the availableproperties for this Profile. |
| isValidProperty | | public boolean isValidProperty(Property prop)(Code) | | Returns true an instance of the specified Property
can be added to this Profile
Parameters:
prop - the Property true an instance of the specified Property can be added to this Profile |
| isValidPropertyInstance | | public boolean isValidPropertyInstance(AbstractPropertyInstance propInst) throws ProfileException(Code) | | Returns true if the specified AbstractPropertyInstance
is valid for this Profile.
Parameters:
propInst - the property instance true if the specified AbstractPropertyInstance is valid
throws:
ProfileException - if an error occurs getting the Propertyassociated to the given property instance |
| match | | public boolean match(Profile prof) throws ProfileException(Code) | | Matches this Profile against the given Profile.
Parameters:
prof - the Profile to match this Profile against true if both Profiles match
throws:
ProfileException - if any errors occur |
| match | | public boolean match(List propInstList) throws ProfileException(Code) | | Matches this Profile against the given Profile.
Parameters:
prof - the Profile to match this Profile against true if both Profiles match
throws:
ProfileException - if any errors occur |
| populateChildObjectPropertyInstances | | protected synchronized void populateChildObjectPropertyInstances(String sTableName) throws PopulateException(Code) | | Populates the ChildObjectPropertyInstances, of the type
specified by the class name given, held by this Profile.
Parameters:
sTableName - the database table name of the AbstractChildObjectclass which can be values for the property instances to be populated
throws:
PopulateException - if any errors occur |
| populateGeneralPropertyInstances | | protected synchronized void populateGeneralPropertyInstances() throws PopulateException(Code) | | Populates the GeneralPropertyInstances held by this
Profile.
throws:
PopulateException - if any errors occur |
| populateProfilePropertyInstances | | protected synchronized void populateProfilePropertyInstances() throws PopulateException(Code) | | Populates the ProfilePropertyInstances held by this
Profile.
throws:
PopulateException - if any errors occur |
| populatePropertyInstancesFromDatabase | | protected void populatePropertyInstancesFromDatabase() throws PopulateException(Code) | | Populates all the property instances in this Profile.
throws:
PopulateException - if an error occurs accessing the data from the database |
| removeProperty | | public void removeProperty(Property prop) throws ProfileException(Code) | | Removes instances of the specified Property from this
Profile.
Parameters:
prop - the Property to remove
throws:
ProfileException - if an error occurs removing the propertyfrom this Profile |
| save | | public Profile save(AbstractProfiledObject proObj) throws ProfileException, EditException(Code) | | Saves this Profile to the data store.
Parameters:
proObj - the 'owner' AbstractProfiledObject the resultant Profile of the save operation
throws:
ProfileException - if a profiled object is not specifiedor, if this is not a new Profile, there is an error populating this Profile with existing property instances
throws:
EditException - if there is an error saving the data to the database |
| setHistorical | | public void setHistorical(boolean bIsHistorical)(Code) | | |
| setIsDefault | | public void setIsDefault(boolean bIsDefault)(Code) | | Sets whether this Profile is the default for the owning
AbstractProfiledObject.
Parameters:
bIsDefault - true if this Profile isthe default, otherwise false. |
| setProfiledObject | | public void setProfiledObject(AbstractProfiledObject obj)(Code) | | Sets the profiled object for this profile.
Parameters:
obj - the profiled object |
| setVersionComment | | public void setVersionComment(String sComment)(Code) | | Sets the version comment for this version of the Profile.
Parameters:
sComment - the version comment |
| 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)
|
|
|