org.apache.oodt.profile
Class ProfileAttributes

java.lang.Object
  org.apache.oodt.profile.ProfileAttributes

All Implemented Interfaces:

Serializable, Cloneable, Comparable, Documentable

public class ProfileAttributes
extends Object
implements Serializable, Cloneable, Comparable, Documentable

Profile attributes. Objects of this class are attributes of profiles.

Author:

Kelly

See Also:

Serialized Form

Field Summary

protected List	children List of zero or more children profile IDs (Strings).
protected String	id Unique identifier, required.
protected String	parent Parent profile ID, optional.
protected String	regAuthority Registration authority, optional.
protected List	revisionNotes Revision notes, zero or more Strings.
protected String	securityType Type of security to apply, optional.
protected String	statusID Status ID, required.
protected String	type Type, required.
protected String	version Version, optional.

Constructor Summary

ProfileAttributes()
Create blank profile attributes.

ProfileAttributes(Node root)
Create profile attributes from an XML document.

ProfileAttributes(String id, String version, String type, String statusID, String securityType, String parent, List children, String regAuthority, List revisionNotes)
Create profile attributes from constituent attributes.

Method Summary

Object	clone()
int	compareTo(Object rhs)
static Document	createProfAttributesDocument() Create a <profAttributes> document using the profiles DTD.
boolean	equals(Object rhs)
List	getChildren() Get the children of this profile.
String	getID() Get the ID.
String	getParent() Get the parent of this profile.
String	getRegAuthority() Get the registration authority of this profile.
List	getRevisionNotes() Get the revision notes of this profile.
String	getSecurityType() Get the security type.
String	getStatusID() Get the status ID.
String	getType() Get the type.
String	getVersion() Get the version.
int	hashCode()
void	setID(String id) Set the ID.
void	setParent(String theParent) Set the Parent
void	setRegAuthority(String regAuthority) Set the registration authority of this profile.
void	setSecurityType(String securityType) Set the security type.
void	setStatusID(String statusID) Set the status ID.
void	setType(String type) Set the type.
void	setVersion(String version) Set the version.
String	toString()
Node	toXML(Document doc) Serialize this attributes as an XML node.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

id

protected String id

Unique identifier, required.

version

protected String version

Version, optional.

type

protected String type

Type, required.

statusID

protected String statusID

Status ID, required.

securityType

protected String securityType

Type of security to apply, optional.

parent

protected String parent

Parent profile ID, optional.

children

protected List children

List of zero or more children profile IDs (Strings).

regAuthority

protected String regAuthority

Registration authority, optional.

revisionNotes

protected List revisionNotes

Revision notes, zero or more Strings.

Constructor Detail

ProfileAttributes

public ProfileAttributes()

Create blank profile attributes.

ProfileAttributes

public ProfileAttributes(Node root)

Create profile attributes from an XML document.

Parameters:

root - The <profAttributes> element.

ProfileAttributes

public ProfileAttributes(String id,
                         String version,
                         String type,
                         String statusID,
                         String securityType,
                         String parent,
                         List children,
                         String regAuthority,
                         List revisionNotes)

Create profile attributes from constituent attributes.

Parameters:

id - The profile ID.

version - Version.

type - Type of the profile.

statusID - Status ID.

securityType - Security type.

parent - Parent profile IDs.

children - Zero or more String child profile IDs.

regAuthority - Registration authority.

revisionNotes - Zero or more String revision notes.

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object rhs)

Overrides:

equals in class Object

compareTo

public int compareTo(Object rhs)

Specified by:

compareTo in interface Comparable

toString

public String toString()

Overrides:

toString in class Object

clone

public Object clone()

Overrides:

clone in class Object

getID

public String getID()

Get the ID.

Returns:

The ID.

getVersion

public String getVersion()

Get the version.

Returns:

The version.

getType

public String getType()

Get the type.

Returns:

The type of the profile.

getStatusID

public String getStatusID()

Get the status ID.

Returns:

The status ID.

getSecurityType

public String getSecurityType()

Get the security type.

Returns:

The security type.

getParent

public String getParent()

Get the parent of this profile.

Returns:

The parent profile's ID.

getChildren

public List getChildren()

Get the children of this profile.

Returns:

A list of String IDs of its children.

getRegAuthority

public String getRegAuthority()

Get the registration authority of this profile.

Returns:

Its registration authority.

getRevisionNotes

public List getRevisionNotes()

Get the revision notes of this profile.

Returns:

A list of String revision notes.

setParent

public void setParent(String theParent)

Set the Parent

Parameters:

theParent - The Parent String.

setID

public void setID(String id)

Set the ID.

Parameters:

id - The ID.

setVersion

public void setVersion(String version)

Set the version.

Parameters:

version - The version.

setType

public void setType(String type)

Set the type.

Parameters:

type - The type of the profile.

setStatusID

public void setStatusID(String statusID)

Set the status ID.

Parameters:

statusID - The status ID.

setSecurityType

public void setSecurityType(String securityType)

Set the security type.

Parameters:

securityType - The security type.

setRegAuthority

public void setRegAuthority(String regAuthority)

Set the registration authority of this profile.

Parameters:

regAuthority - Its registration authority.

toXML

public Node toXML(Document doc)
           throws DOMException

Serialize this attributes as an XML node.

Specified by:

toXML in interface Documentable

Parameters:

doc - The document that will own this node.

Returns:

The XML element <profAttributes> representing these attributes.

Throws:

DOMException - If an error occurs creating the XML nodes.

createProfAttributesDocument

public static Document createProfAttributesDocument()

Create a <profAttributes> document using the profiles DTD.

Returns:

A <profAttributs> document with the profiles DTD.