|
|||||||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||||||
| Packages that use IdASException | |
|---|---|
| org.eclipse.higgins.idas.api | Defines the core set of interfaces for IdAS. |
| org.eclipse.higgins.idas.api.model | This package defines core set of interfaces to simplify query and interpretation of IdAS context's schemas. |
| Uses of IdASException in org.eclipse.higgins.idas.api |
|---|
| Subclasses of IdASException in org.eclipse.higgins.idas.api | |
class |
AuthenticationException
Thrown when an attempt to authenticate has failed. |
class |
BadFilterException
|
class |
ContextNotOpenException
Thrown when methods requiring an open Context are called on a non-open Context. |
class |
ContextOpenException
Thrown when IContext.open() is called on an already open context. |
class |
EntityExistsException
|
class |
InvalidEntityIDException
Thrown when a specified Type is invalid. |
class |
InvalidTypeException
Thrown when a specified Type is invalid. |
class |
MultipleValuesExistException
Thrown in cases where an attribute is expected to have a single value but doesn't. |
class |
NoSuchEntityException
Thrown when a specified Entity is not found in the Context. |
class |
NotImplementedException
Thrown when the method being called has not been implemented by the context provider. |
class |
NotSingleValuedAttributeException
Thrown in cases where an attribute's model specifies that the attribute may hold multiple values and the caller expects the attribute to be restricted to a single value (and thus castable to ISingleValuedAttribute. |
class |
UnhandledExtensionException
|
class |
ValueAlreadyExistsException
Thrown in cases where a value is being added to an attribute and that value already exists. |
| Methods in org.eclipse.higgins.idas.api that throw IdASException | |
void |
IFilterEntityTypeAssertion.setAssertionValue(URI assertion)
Specifies the assertion data to be tested against an IEntity's type. |
IAttributeSimpleValueModel |
ISimpleAttrValue.getModel()
Returns the model for this type of attribute value as it is defined in the context's schema. |
URI |
IAttribute.getAttrID()
Returns the attribute ID of this attribute as a URI. |
Iterator |
IAttribute.getValues()
Returns all values for this attribute. |
Iterator |
IAttribute.getValues(IExtension[] extensions)
Returns all values for this attribute. |
IAttributeValue |
IAttribute.addValue(URI dataType)
Creates a new value for this attribute. |
IAttributeValue |
IAttribute.addValue(IAttributeValue copyFrom)
Creates a new value for this attribute by copying the passed IAttributeValue
Note: This operation is only applied to any backing data store after
IContext.applyUpdates() is called. |
ISimpleAttrValue |
IAttribute.addSimpleValue(URI dataType,
Object data)
Creates a new simple value for this attribute. |
IComplexAttrValue |
IAttribute.addComplexValue(URI dataType)
Creates a new complex value for this attribute. |
void |
IAttribute.remove()
Removes this attribute from its container Note: This operation is only applied to any backing data store after IContext.applyUpdates() is called. |
IAttributeModel |
IAttribute.getModel()
Returns a model of this type of attribute as it defined in the context's schema. |
boolean |
IAttribute.isSingleValued()
Convenience method which returns true when the model for this attribute dictates that only a single value may exist. |
boolean |
IAttribute.equals(IAttribute attr)
Returns true if the passed attribute is equal to this one. |
boolean |
IAttributeValue.isSimple()
|
URI |
IAttributeValue.getDataType()
Deprecated. Instead, call IAttributeValue#getModel() and from that call IModel#getType().
Doing this is equivalent to calling this method. |
URI |
IAttributeValue.getValueType()
Returns this value's data type (like string, int, address) This is a shortcut for calling getModel().getType(). |
void |
IAttributeValue.remove()
Removes this value from its IAttribute container Note: This operation is only applied to any backing data store after IContext.applyUpdates() is called. |
boolean |
IAttributeValue.equals(IAttributeValue value)
returns true if this IAttributeValue is equal to the passed IAttributeValue This should test the attribute ID, metadata, and the value for equality. |
URI |
ITypedValue.getDataType()
Deprecated. Use getModel on the attribute value |
String |
ITypedValue.getLexical()
Returns a lexical representation if this value is a literal |
String |
ITypedValue.getCanonical()
Returns the canonical representation if this value is a literal |
Object |
ITypedValue.getData()
Returns the underlying Java object holding this simple type's value. |
void |
ITypedValue.setData(Object data)
Sets the data for this simple value. |
String |
IContextFactory.getName()
|
Iterator |
IContextFactory.getContexts(String filter)
|
IContext |
IContextFactory.createContext(IContextId contextID)
Using a context ID, creates an instance of IContext and returns it. |
String |
IContextFactory.getPolicy()
Returns the policy in effect for this Context Factory. |
void |
IContextFactory.setPolicy(String policy)
Sets the policy for for this Context Factory. |
IContext |
IEntity.getContext()
|
String |
IEntity.getEntityID()
Returns the Contextually unique identifier of this Entity. |
URI |
IEntity.getEntityType()
Deprecated. Instead, call IBlankEntity.getModel() and from that call IModel#getType().
Doing this is equivalent to calling this method. |
void |
IEntity.remove()
Removes this Entity from its Context. |
void |
IFilterAssertion.setComparator(String comparator)
Set the comparison operator (equal, less, greater, beginsWith, etc.) |
void |
IFilterAssertion.setID(URI id,
boolean bIncludeSubtypes)
Identifies the component to be compared. For entity attribute assertions, this would be the type of the attribute (see IAttribute.getAttrID())For entity ID and entity type assertions, the type is not set. For entity metadata assertions, this would be the type of the metadata (see IMetadata#getID()) |
void |
IFilterAssertion.setID(URI id)
|
void |
IFilterAssertion.includeSubtypes(boolean bIncludeSubtypes)
Calling this the same as calling IFilterAssertion.setID(URI, boolean) and setting the boolean to true. |
String |
IContext.open(Object authentication,
IExtension[] extensions)
Opens this Context using the provided authentication object. |
String |
IContext.open(Object authentication)
|
void |
IContext.close()
Closes this Context and returns it to an un-open state. |
boolean |
IContext.isOpen(Object identity)
Tests whether this context is open and authenticated using the specified identity |
String |
IContext.getSchema()
Returns the schema governing this context. |
void |
IContext.setSchema(String schema)
Sets the schema governing this context. |
IContextModel |
IContext.getContextModel()
Returns a model of the context object as it defined in the context's schema. |
URI |
IContext.getContextID()
Returns a reference to this Context. |
String |
IContext.exportData(String filter,
String representationFormat)
Exports this Context. |
void |
IContext.importData(String filter,
String representationFormat)
Imports this Context. |
IAuthNAttributesMaterials |
IContext.buildAuthNAttributesMaterials()
Builds an IAuthNAttributesMaterials that may be used when calling IContext.open(Object) |
IAttribute |
IContext.buildAttribute(URI attrID)
Builds an IAttribute (unassociated with any Entity). |
IFilter |
IContext.buildFilter()
Builds an IFilter instance that may be used when calling IContext.getEntities(IFilter) |
IFilterAttributeAssertion |
IContext.buildAttributeAssertion()
Builds an assertion for Entity Attributes (see IHasAttributes.getAttributes() and IHasAttributes.getAttribute(URI))
which can be passed to IFilter.setAssertion(IFilterAssertion) |
IFilterEntityIDAssertion |
IContext.buildEntityIDAssertion()
Builds an assertion for Entity IDs (see IEntity.getEntityID())
which can be passed to IFilter.setAssertion(IFilterAssertion)
Note that this is simply a convenience method equivalent to creating an
IFilterAttributeAssertion for the
http://www.eclipse.org/higgins/ontologies/2008/6/higgins#entityId attribute |
IFilterEntityTypeAssertion |
IContext.buildEntityTypeAssertion()
Builds an assertion for Entity Types (see IEntity.getEntityType())
which can be passed to IFilter.setAssertion(IFilterAssertion) |
ISimpleAttrValue |
IContext.buildSimpleAttrValue(URI dataType,
Object value)
Builds a simple attribute value to be passed to IFilterAttributeAssertion.setAssertionValue(IAttributeValue). |
IComplexAttrValue |
IContext.buildComplexAttrValue(URI dataType)
Builds a complex attribute value to be passed to IFilterAttributeAssertion.setAssertionValue(IAttributeValue). |
IEntity |
IContext.addEntity(URI entityType,
String entityID)
Creates a new Entity for this Context. This call is typically followed by one or more calls to IHasAttributes.addAttribute(java.net.URI) on the returned IEntity
Note: This operation is only applied to any backing data
store after IContext.applyUpdates() |
IEntity |
IContext.addEntity(IEntity copyFrom)
Creates a new Entity for this Context by copying the data from the passed entity Note: This operation is only applied to any backing data store after IContext.applyUpdates() is called. |
IEntity |
IContext.getEntity(String entityID)
This is the same as passing null as the attrSelectionList in IContext.getEntity(String, Iterator) |
IEntity |
IContext.getEntity(String entityID,
Iterator attrSelectionList)
Returns the Entity matching the specified entityID. |
Iterator |
IContext.getEntities(IFilter filter)
|
Iterator |
IContext.getEntities(IFilter filter,
Iterator attrSelectionList)
From this context, return IEntitys that match the specified filter |
boolean |
IContext.verifyEntityAttributes(String entityID,
Iterator attributes)
Simple method for comparing a set of attribute assertions against a Entity. |
void |
IContext.applyUpdates()
Applies all update operations which have been called on this Context and called on any element held by this Context (including entities, attributes, attribute meta-attributes and it's value(s), and attribute values) to a backing data store. |
void |
IContext.cancelUpdates()
Cancels all update operations which have been called on this Context and called on any element held by this Context (including entities, attributes, attribute meta-attributes and it's value(s), and attribute values). |
void |
IContext.setComponentSetting(String key,
Object value,
boolean failUnsupported)
Used to update one setting element for this context. |
void |
IContext.setComponentSetting(String key,
Object value)
|
void |
IFilterAttributeAssertion.setAssertionValue(IAttributeValue assertion)
Specifies the assertion data to be tested against values of a Entity's attribute. |
void |
IFilterAttributeAssertion.setAttributeFilter(IFilter attributeFilter)
Adds an (meta) attribute filter to this attribute assertion. |
String[] |
IContextId.getTypes()
|
URI[] |
IContextId.getUris()
|
Map |
IContextId.getConfiguration()
|
void |
IFilter.setAssertion(IFilterAssertion assertion)
When this is called, IFilter.addFilter(IFilter) and IFilter.setOperator(String) may not be called. |
void |
IFilter.setOperator(String operator)
|
void |
IFilter.addFilter(IFilter filter)
Adds a filter to the set of filters. |
void |
IFilter.addFilter(IFilterAssertion filterAssertion)
Adds a filter containing the passed IFilterAssertion. |
void |
IFilterEntityIDAssertion.setAssertionValue(String assertion)
Specifies the assertion data to be tested against an IEntity's unique ID. |
IAttributeValue |
ISingleValuedAttribute.getValue()
Returns the value for this attribute. |
IEntityModel |
IBlankEntity.getModel()
Returns a model of this type of Entities as it defined in the context's schema. |
Iterator |
IHasAttributes.getAttributes()
Return all attributes of this object |
IAttribute |
IHasAttributes.getAttribute(URI attrID)
Returns the specified attribute of this object. |
ISingleValuedAttribute |
IHasAttributes.getSingleValuedAttribute(URI attrID)
Returns the specified attribute of this object as an ISingleValuedAttribute. |
IAttribute |
IHasAttributes.addAttribute(URI attrID)
Creates a new Attribute for this container of attributes (typically IEntity). |
IAttribute |
IHasAttributes.addAttribute(IAttribute copyFrom)
Creates a new Attribute for this container of attributes (typically IEntity) by copying the data from
the passed IAttribute. |
void |
IHasAttributes.removeAttribute(URI attrID)
Deletes the attribute specified by attrID. |
void |
IHasAttributes.removeAttributeValue(URI attrID,
Object value)
Deletes the specified value from the specified attrID. |
void |
IHasAttributes.removeAttributeValue(IAttribute attr)
Deletes an attribute's value(s) based on the information passed in attr. |
boolean |
IHasAttributes.equals(IHasAttributes attributes)
Returns true if the passed attribute set is equal to this one. |
| Uses of IdASException in org.eclipse.higgins.idas.api.model |
|---|
| Subclasses of IdASException in org.eclipse.higgins.idas.api.model | |
class |
IdASModelException
|
| Methods in org.eclipse.higgins.idas.api.model that throw IdASException | |
IModel |
IContextModel.getModel(URI type)
Generic method to query context model for any kind of element matching the specified type. |
Iterator |
IContextModel.getEntityModels()
Returns IEntityModels for the entities
which are defined (allowed) in this context model. |
IEntityModel |
IContextModel.getEntityModel(URI entityType)
Returns the IEntityModel for the specified entity type |
Iterator |
IContextModel.getAttributeModels()
Returns IAttributeModels for the attributes which are defined (allowed) by this context's model. |
IAttributeModel |
IContextModel.getAttributeModel(URI attrID)
Returns IAttributeModel for the specified attribute ID |
Iterator |
IEntityModel.getAttributeModels()
Returns IAttributeModels for the attributes which are defined (allowed) in this entity model. |
IAttributeModel |
IEntityModel.getAttributeModel(URI attrID)
Returns IAttributeModel for the specified attribute ID |
int |
IAttributeValueModel.getMaxCardinality()
Deprecated. This has been moved to IAttributeModel |
int |
IAttributeValueModel.getMinCardinality()
Deprecated. This has been moved to IAttributeModel |
boolean |
IAttributeValueModel.isSimple()
Determines whether this value model represents simple attribute's value. |
boolean |
IAttributeSimpleValueModel.isValidValue(Object valueForm)
Determines whether given Object is valid value form of
represented value. |
boolean |
IAttributeSimpleValueModel.isValid(String lexicalForm)
Determines whether given String is valid lexical form of
represented value. |
Object |
IAttributeSimpleValueModel.toValueForm(String lexicalForm)
Convert given String to value form of represented value. |
String |
IAttributeSimpleValueModel.toLexicalForm(Object value)
Convert given Object to lexical form of represented value. |
IAttributeValueModel |
IAttributeModel.getValueModel()
Deprecated. Attribute values can all have different value models now |
boolean |
IAttributeModel.isDirect()
Deprecated. Don't know what this is |
int |
IAttributeModel.getMaxCardinality()
Returns the maximum number of values required by occurrences of this attribute. |
int |
IAttributeModel.getMinCardinality()
Returns the minimum number of values required by occurrences of this attribute. |
URI |
IModel.getType()
Returns the type of element that this model represents. |
IDisplayData |
IModel.getDisplayData()
Returns display data information for this model. |
|
|||||||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||||||