ibrokerkit.iname4java.store
Interface Xri

All Superinterfaces:

java.lang.Comparable<Xri>, java.io.Serializable

All Known Implementing Classes:

AbstractXri, GrsXri, OpenxriXri

public interface Xri
extends java.io.Serializable, java.lang.Comparable<Xri>

This class is used to represent i-names (not i-numbers). - In the GRS, this corresponds to an i-name object. - In OpenXRI, this corresponds to a subsegment object. Every i-name has 0..1 associated parent authorities. Every i-name has 1 associated authority. In the case of synonyms, multiple i-names can share the same authority. Associated with an authority are the elements of an XRD.

Method Summary

void	addEquivID(org.openxri.xml.EquivID equivID)
void	addRedirect(org.openxri.xml.Redirect redirect)
void	addRef(org.openxri.xml.Ref ref)
void	addService(org.openxri.xml.Service service)
void	addServices(org.openxri.xml.Service[] services)
void	deleteAllServices()
void	deleteCanonicalEquivID()
void	deleteEquivID(org.openxri.xml.EquivID equivID)
void	deleteExtension()
void	deleteRedirect(org.openxri.xml.Redirect redirect)
void	deleteRef(org.openxri.xml.Ref ref)
void	deleteService(org.openxri.xml.Service service)
void	deleteStandardServices()
java.util.List<java.lang.String>	getAliases() Returns a list of "full names" of i-names that resolve to the authority of this i-name.
java.lang.String	getAuthorityAttribute(java.lang.String key)
java.lang.String	getAuthorityId() Returns the ID of the OpenXRI authority of this i-name.
org.openxri.xml.CanonicalEquivID	getCanonicalEquivID()
org.openxri.xml.CanonicalID	getCanonicalID()
java.util.Date	getDate() Returns the registration date of this i-name.
java.util.List<org.openxri.xml.EquivID>	getEquivIDs()
java.lang.String	getExtension()
java.lang.String	getFullName() Returns a single "full name" of this i-name.
java.util.List<java.lang.String>	getFullNames() Returns all "full names" of this i-name.
java.lang.String	getLocalName() Returns the "local name" of this i-name.
java.util.List<java.lang.String>	getParentAliases() Returns a list of "full names" of i-names that resolve to the parent authority of this i-name.
java.util.List<org.openxri.xml.Redirect>	getRedirects()
java.util.List<org.openxri.xml.Ref>	getRefs()
java.util.List<org.openxri.xml.Service>	getServices()
java.lang.String	getXriAttribute(java.lang.String key)
boolean	hasAuthorityAttribute(java.lang.String key)
boolean	hasXriAttribute(java.lang.String key)
boolean	isStale() Returns true, if the i-name is "stale".
void	setAuthorityAttribute(java.lang.String key, java.lang.String value)
void	setCanonicalEquivID(org.openxri.xml.CanonicalEquivID canonicalID)
void	setCanonicalID(org.openxri.xml.CanonicalID canonicalID)
void	setExtension(java.lang.String extension)
void	setXriAttribute(java.lang.String key, java.lang.String value)

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getLocalName

java.lang.String getLocalName()

Returns the "local name" of this i-name. In the case of a top-level i-name, this is simply the i-name itself (e.g. =myname) In the case of a community i-name, this is the subsegment (e.g. *myname)

getFullName

java.lang.String getFullName()

Returns a single "full name" of this i-name. In the case of a top-level i-name, this is simply the i-name itself (e.g. =myname) In the case of a community i-name, this is the whole i-name (e.g. =mycommunity*myname)

getFullNames

java.util.List<java.lang.String> getFullNames()

Returns all "full names" of this i-name. This can be more than one if the i-name is a community i-name, and if one or more parent i-names higher up in the hierarchy have synonyms. For example, if =mycommunity and =myothercommunity are synonyms, then there could be a community i-name *myname which has two "full names": =mycommunity*myname and =myothercommunity*myname

getAuthorityId

java.lang.String getAuthorityId()

Returns the ID of the OpenXRI authority of this i-name.

getDate

java.util.Date getDate()

Returns the registration date of this i-name.

getParentAliases

java.util.List<java.lang.String> getParentAliases()

Returns a list of "full names" of i-names that resolve to the parent authority of this i-name.

getAliases

java.util.List<java.lang.String> getAliases()

Returns a list of "full names" of i-names that resolve to the authority of this i-name.

isStale

boolean isStale()

Returns true, if the i-name is "stale". An i-name is "stale" if it has a parent authority (i.e. is a community i-name) but the parent authority has no "full name". For example, let's assume we have a community i-name @free*earth*moon. If someone deletes the community i-name *earth, then *moon still exists, but its parent authority has no "full name" anymore. Therefore *moon is stale.

getXriAttribute

java.lang.String getXriAttribute(java.lang.String key)
                                 throws XriStoreException

Throws:

XriStoreException

hasXriAttribute

boolean hasXriAttribute(java.lang.String key)
                        throws XriStoreException

Throws:

XriStoreException

setXriAttribute

void setXriAttribute(java.lang.String key,
                     java.lang.String value)
                     throws XriStoreException

Throws:

XriStoreException

getAuthorityAttribute

java.lang.String getAuthorityAttribute(java.lang.String key)
                                       throws XriStoreException

Throws:

XriStoreException

hasAuthorityAttribute

boolean hasAuthorityAttribute(java.lang.String key)
                              throws XriStoreException

Throws:

XriStoreException

setAuthorityAttribute

void setAuthorityAttribute(java.lang.String key,
                           java.lang.String value)
                           throws XriStoreException

Throws:

XriStoreException

getCanonicalID

org.openxri.xml.CanonicalID getCanonicalID()
                                           throws XriStoreException

Throws:

XriStoreException

getCanonicalEquivID

org.openxri.xml.CanonicalEquivID getCanonicalEquivID()
                                                     throws XriStoreException

Throws:

XriStoreException

getExtension

java.lang.String getExtension()
                              throws XriStoreException

Throws:

XriStoreException

getEquivIDs

java.util.List<org.openxri.xml.EquivID> getEquivIDs()
                                                    throws XriStoreException

Throws:

XriStoreException

getRefs

java.util.List<org.openxri.xml.Ref> getRefs()
                                            throws XriStoreException

Throws:

XriStoreException

getRedirects

java.util.List<org.openxri.xml.Redirect> getRedirects()
                                                      throws XriStoreException

Throws:

XriStoreException

getServices

java.util.List<org.openxri.xml.Service> getServices()
                                                    throws XriStoreException

Throws:

XriStoreException

setCanonicalID

void setCanonicalID(org.openxri.xml.CanonicalID canonicalID)
                    throws XriStoreException

Throws:

XriStoreException

setCanonicalEquivID

void setCanonicalEquivID(org.openxri.xml.CanonicalEquivID canonicalID)
                         throws XriStoreException

Throws:

XriStoreException

setExtension

void setExtension(java.lang.String extension)
                  throws XriStoreException

Throws:

XriStoreException

addEquivID

void addEquivID(org.openxri.xml.EquivID equivID)
                throws XriStoreException

Throws:

XriStoreException

addRef

void addRef(org.openxri.xml.Ref ref)
            throws XriStoreException

Throws:

XriStoreException

addRedirect

void addRedirect(org.openxri.xml.Redirect redirect)
                 throws XriStoreException

Throws:

XriStoreException

addService

void addService(org.openxri.xml.Service service)
                throws XriStoreException

Throws:

XriStoreException

addServices

void addServices(org.openxri.xml.Service[] services)
                 throws XriStoreException

Throws:

XriStoreException

deleteCanonicalEquivID

void deleteCanonicalEquivID()
                            throws XriStoreException

Throws:

XriStoreException

deleteExtension

void deleteExtension()
                     throws XriStoreException

Throws:

XriStoreException

deleteEquivID

void deleteEquivID(org.openxri.xml.EquivID equivID)
                   throws XriStoreException

Throws:

XriStoreException

deleteRef

void deleteRef(org.openxri.xml.Ref ref)
               throws XriStoreException

Throws:

XriStoreException

deleteRedirect

void deleteRedirect(org.openxri.xml.Redirect redirect)
                    throws XriStoreException

Throws:

XriStoreException

deleteService

void deleteService(org.openxri.xml.Service service)
                   throws XriStoreException

Throws:

XriStoreException

deleteAllServices

void deleteAllServices()
                       throws XriStoreException

Throws:

XriStoreException

deleteStandardServices

void deleteStandardServices()
                            throws XriStoreException

Throws:

XriStoreException