org.eclipse.higgins.idas.spi
Class BasicContext

java.lang.Object
  extended byorg.eclipse.higgins.idas.spi.BasicMetadataSet
      extended byorg.eclipse.higgins.idas.spi.BasicContext
All Implemented Interfaces:
org.eclipse.higgins.idas.api.IContext, org.eclipse.higgins.idas.api.IHasMetadata, IMetadataContainer, ISubjectContainer

public class BasicContext
extends BasicMetadataSet
implements org.eclipse.higgins.idas.api.IContext, ISubjectContainer

Basic implementation of IContext. The intent of this class is to be used by Context Provider writers as a superclass for IContext instances. The benefits of using this class are that you will pick up any convenience methods as well as have the latest methods stubbed out such that when new methods are added to IContext and implemented here, the subclass will still compile.


Constructor Summary
BasicContext()
           
BasicContext(Iterator metadataSet)
           
 
Method Summary
 org.eclipse.higgins.idas.api.IMetadata addMetadata(org.eclipse.higgins.idas.api.IMetadata copyFrom)
           
 org.eclipse.higgins.idas.api.IMetadata addMetadata(URI type)
           
 org.eclipse.higgins.idas.api.IContextRelationship addRelationship(URI relationshipType)
           
 org.eclipse.higgins.idas.api.IDigitalSubject addSubject(org.eclipse.higgins.idas.api.IDigitalSubject copyFrom)
           
 org.eclipse.higgins.idas.api.IDigitalSubject addSubject(URI type, String subjectID)
           
 void applyUpdates()
           
 org.eclipse.higgins.idas.api.IAttribute buildAttribute(URI attrID)
           
 org.eclipse.higgins.idas.api.IFilterAttributeAssertion buildAttributeAssertion()
           
 org.eclipse.higgins.idas.api.IAuthNAttributesMaterials buildAuthNAttributesMaterials()
           
 org.eclipse.higgins.idas.api.IComplexAttrValue buildComplexAttrValue(URI type)
           
 org.eclipse.higgins.idas.api.IFilterCUIDAssertion buildCUIDAssertion()
           
 org.eclipse.higgins.idas.api.IFilter buildFilter()
           
 org.eclipse.higgins.idas.api.IFilterMetadataAssertion buildMetadataAssertion()
           
 org.eclipse.higgins.idas.api.IContextRelationship buildRelationship(URI type)
           
 org.eclipse.higgins.idas.api.ISimpleAttrValue buildSimpleAttrValue(URI type, Object data)
           
 org.eclipse.higgins.idas.api.IFilterTypeAssertion buildTypeAssertion()
           
 void cancelUpdates()
           
 void close()
           
static org.eclipse.higgins.idas.api.ISimpleAttrValue createSimpleValue(URI type, Object data, IAttributeValueContainer container)
           
 String exportData(String filter, String representationFormat)
           
 org.eclipse.higgins.idas.api.model.IContextModel getContextModel()
           
 URI getContextRef()
           
 Iterator getMetadataSet()
           
 org.eclipse.higgins.idas.api.model.IModel getModel(URI elementType)
           
 Iterator getRelationships()
           
 String getSchema()
           
 org.eclipse.higgins.idas.api.IDigitalSubject getSubject(String cuid)
           
 org.eclipse.higgins.idas.api.IDigitalSubject getSubject(String cuid, Iterator attrSelectionList)
           
 Iterator getSubjects(org.eclipse.higgins.idas.api.IFilter filter)
           
 Iterator getSubjects(org.eclipse.higgins.idas.api.IFilter filter, Iterator attrs)
           
 void importData(String filter, String representationFormat)
           
 boolean isOpen(Object identity)
           
 String open(Object authentication)
           
 void setSchema(String schema)
           
 void updateNotification(SubjectNotification subjectNotif)
           
 boolean verifySubjectAttributes(String cuid, Iterator attributes)
           
 
Methods inherited from class org.eclipse.higgins.idas.spi.BasicMetadataSet
equals, getMetadata, updateNotification
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BasicContext

public BasicContext()
             throws org.eclipse.higgins.idas.api.IdASException

BasicContext

public BasicContext(Iterator metadataSet)
             throws org.eclipse.higgins.idas.api.IdASException
Method Detail

close

public void close()
           throws org.eclipse.higgins.idas.api.IdASException
Specified by:
close in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

exportData

public String exportData(String filter,
                         String representationFormat)
                  throws org.eclipse.higgins.idas.api.IdASException
Specified by:
exportData in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

getContextModel

public org.eclipse.higgins.idas.api.model.IContextModel getContextModel()
                                                                 throws org.eclipse.higgins.idas.api.IdASException
Specified by:
getContextModel in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

getModel

public org.eclipse.higgins.idas.api.model.IModel getModel(URI elementType)
                                                   throws org.eclipse.higgins.idas.api.IdASException
Specified by:
getModel in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

getContextRef

public URI getContextRef()
                  throws org.eclipse.higgins.idas.api.IdASException
Specified by:
getContextRef in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

getSchema

public String getSchema()
                 throws org.eclipse.higgins.idas.api.IdASException
Specified by:
getSchema in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

getSubject

public org.eclipse.higgins.idas.api.IDigitalSubject getSubject(String cuid)
                                                        throws org.eclipse.higgins.idas.api.IdASException
Specified by:
getSubject in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

getSubject

public org.eclipse.higgins.idas.api.IDigitalSubject getSubject(String cuid,
                                                               Iterator attrSelectionList)
                                                        throws org.eclipse.higgins.idas.api.IdASException
Specified by:
getSubject in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

getSubjects

public Iterator getSubjects(org.eclipse.higgins.idas.api.IFilter filter)
                     throws org.eclipse.higgins.idas.api.IdASException
Specified by:
getSubjects in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

getSubjects

public Iterator getSubjects(org.eclipse.higgins.idas.api.IFilter filter,
                            Iterator attrs)
                     throws org.eclipse.higgins.idas.api.IdASException
Specified by:
getSubjects in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

importData

public void importData(String filter,
                       String representationFormat)
                throws org.eclipse.higgins.idas.api.IdASException
Specified by:
importData in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

isOpen

public boolean isOpen(Object identity)
               throws org.eclipse.higgins.idas.api.IdASException
Specified by:
isOpen in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

open

public String open(Object authentication)
            throws org.eclipse.higgins.idas.api.IdASException,
                   org.eclipse.higgins.idas.api.ContextOpenException
Specified by:
open in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException
org.eclipse.higgins.idas.api.ContextOpenException

setSchema

public void setSchema(String schema)
               throws org.eclipse.higgins.idas.api.IdASException
Specified by:
setSchema in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

verifySubjectAttributes

public boolean verifySubjectAttributes(String cuid,
                                       Iterator attributes)
                                throws org.eclipse.higgins.idas.api.IdASException
Specified by:
verifySubjectAttributes in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

getMetadataSet

public Iterator getMetadataSet()
                        throws org.eclipse.higgins.idas.api.IdASException
Specified by:
getMetadataSet in interface org.eclipse.higgins.idas.api.IHasMetadata
Overrides:
getMetadataSet in class BasicMetadataSet
Throws:
org.eclipse.higgins.idas.api.IdASException

addRelationship

public org.eclipse.higgins.idas.api.IContextRelationship addRelationship(URI relationshipType)
                                                                  throws org.eclipse.higgins.idas.api.IdASException
Specified by:
addRelationship in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

getRelationships

public Iterator getRelationships()
                          throws org.eclipse.higgins.idas.api.IdASException
Specified by:
getRelationships in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

buildAttributeAssertion

public org.eclipse.higgins.idas.api.IFilterAttributeAssertion buildAttributeAssertion()
                                                                               throws org.eclipse.higgins.idas.api.IdASException
Specified by:
buildAttributeAssertion in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

buildCUIDAssertion

public org.eclipse.higgins.idas.api.IFilterCUIDAssertion buildCUIDAssertion()
                                                                     throws org.eclipse.higgins.idas.api.IdASException
Specified by:
buildCUIDAssertion in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

buildFilter

public org.eclipse.higgins.idas.api.IFilter buildFilter()
                                                 throws org.eclipse.higgins.idas.api.IdASException
Specified by:
buildFilter in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

buildMetadataAssertion

public org.eclipse.higgins.idas.api.IFilterMetadataAssertion buildMetadataAssertion()
                                                                             throws org.eclipse.higgins.idas.api.IdASException
Specified by:
buildMetadataAssertion in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

buildRelationship

public org.eclipse.higgins.idas.api.IContextRelationship buildRelationship(URI type)
                                                                    throws org.eclipse.higgins.idas.api.IdASException
Specified by:
buildRelationship in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

buildTypeAssertion

public org.eclipse.higgins.idas.api.IFilterTypeAssertion buildTypeAssertion()
                                                                     throws org.eclipse.higgins.idas.api.IdASException
Specified by:
buildTypeAssertion in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

buildSimpleAttrValue

public org.eclipse.higgins.idas.api.ISimpleAttrValue buildSimpleAttrValue(URI type,
                                                                          Object data)
                                                                   throws org.eclipse.higgins.idas.api.IdASException
Specified by:
buildSimpleAttrValue in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

createSimpleValue

public static org.eclipse.higgins.idas.api.ISimpleAttrValue createSimpleValue(URI type,
                                                                              Object data,
                                                                              IAttributeValueContainer container)
                                                                       throws org.eclipse.higgins.idas.api.IdASException
Throws:
org.eclipse.higgins.idas.api.IdASException

addSubject

public org.eclipse.higgins.idas.api.IDigitalSubject addSubject(URI type,
                                                               String subjectID)
                                                        throws org.eclipse.higgins.idas.api.IdASException,
                                                               org.eclipse.higgins.idas.api.InvalidTypeException,
                                                               org.eclipse.higgins.idas.api.InvalidSubjectIDException,
                                                               org.eclipse.higgins.idas.api.SubjectExistsException
Specified by:
addSubject in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException
org.eclipse.higgins.idas.api.InvalidTypeException
org.eclipse.higgins.idas.api.InvalidSubjectIDException
org.eclipse.higgins.idas.api.SubjectExistsException

addMetadata

public org.eclipse.higgins.idas.api.IMetadata addMetadata(URI type)
                                                   throws org.eclipse.higgins.idas.api.IdASException,
                                                          org.eclipse.higgins.idas.api.InvalidTypeException
Specified by:
addMetadata in interface org.eclipse.higgins.idas.api.IHasMetadata
Overrides:
addMetadata in class BasicMetadataSet
Throws:
org.eclipse.higgins.idas.api.IdASException
org.eclipse.higgins.idas.api.InvalidTypeException

buildComplexAttrValue

public org.eclipse.higgins.idas.api.IComplexAttrValue buildComplexAttrValue(URI type)
                                                                     throws org.eclipse.higgins.idas.api.IdASException,
                                                                            org.eclipse.higgins.idas.api.InvalidTypeException
Specified by:
buildComplexAttrValue in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException
org.eclipse.higgins.idas.api.InvalidTypeException

addSubject

public org.eclipse.higgins.idas.api.IDigitalSubject addSubject(org.eclipse.higgins.idas.api.IDigitalSubject copyFrom)
                                                        throws org.eclipse.higgins.idas.api.IdASException,
                                                               org.eclipse.higgins.idas.api.SubjectExistsException
Specified by:
addSubject in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException
org.eclipse.higgins.idas.api.SubjectExistsException

addMetadata

public org.eclipse.higgins.idas.api.IMetadata addMetadata(org.eclipse.higgins.idas.api.IMetadata copyFrom)
                                                   throws org.eclipse.higgins.idas.api.IdASException
Specified by:
addMetadata in interface org.eclipse.higgins.idas.api.IHasMetadata
Overrides:
addMetadata in class BasicMetadataSet
Throws:
org.eclipse.higgins.idas.api.IdASException

applyUpdates

public void applyUpdates()
                  throws org.eclipse.higgins.idas.api.IdASException
Specified by:
applyUpdates in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

cancelUpdates

public void cancelUpdates()
                   throws org.eclipse.higgins.idas.api.IdASException
Specified by:
cancelUpdates in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

buildAuthNAttributesMaterials

public org.eclipse.higgins.idas.api.IAuthNAttributesMaterials buildAuthNAttributesMaterials()
                                                                                     throws org.eclipse.higgins.idas.api.IdASException
Specified by:
buildAuthNAttributesMaterials in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

buildAttribute

public org.eclipse.higgins.idas.api.IAttribute buildAttribute(URI attrID)
                                                       throws org.eclipse.higgins.idas.api.IdASException
Specified by:
buildAttribute in interface org.eclipse.higgins.idas.api.IContext
Throws:
org.eclipse.higgins.idas.api.IdASException

updateNotification

public void updateNotification(SubjectNotification subjectNotif)
                        throws org.eclipse.higgins.idas.api.IdASException
Specified by:
updateNotification in interface ISubjectContainer
Parameters:
subjectNotif -
Throws:
org.eclipse.higgins.idas.api.IdASException