public interface ITypingService extends IIdentifierSystem
Modifier and Type | Method and Description |
---|---|
boolean |
conformsToType(String pid,
String typeIdentifier) |
PropertyDefinition |
describeProperty(String propertyIdentifier)
Retrieves a property definition
|
TypeDefinition |
describeType(String typeIdentifier)
Retrieves a type definition
|
EntityClass |
determineEntityClass(String identifier)
Determines whether the given identifier references a simple object, a
property, a type etc.
|
Object |
genericResolve(String pid)
Resolves the given PID without previous knowledge about the kind of
entity it identifies (e.g. a common PID record, a property or type
definition etc.).
|
PIDInformation |
queryByType(String pid,
String typeIdentifier,
boolean includePropertyNames)
Queries all properties of a type available from the given PID.
|
PIDInformation |
queryByTypeWithConformance(String pid,
List<String> typeIdentifiers,
boolean includePropertyNames) |
PIDInformation |
queryByTypeWithConformance(String pid,
String typeIdentifier,
boolean includePropertyNames)
Same as
queryByType(java.lang.String, java.lang.String, boolean) , but also performs a type conformance check. |
PIDInformation |
queryProperty(String pid,
String propertyIdentifier)
Queries a single property from the PID.
|
deletePID, isIdentifierRegistered, queryAllProperties, queryByType, queryProperty, registerPID
PropertyDefinition describeProperty(String propertyIdentifier) throws IOException
propertyIdentifier
- IOException
TypeDefinition describeType(String typeIdentifier) throws IOException
typeIdentifier
- IOException
boolean conformsToType(String pid, String typeIdentifier) throws IOException
IOException
Object genericResolve(String pid) throws IOException
pid
- IOException
PIDInformation queryProperty(String pid, String propertyIdentifier) throws IOException
pid
- propertyIdentifier
- must be registered in the type registryIOException
IllegalArgumentException
- if the property is defined but ambiguous (type registry query
returned multiple results).PIDInformation queryByType(String pid, String typeIdentifier, boolean includePropertyNames) throws IOException, InconsistentRecordsException
pid
- typeIdentifier
- a type identifier, not a nameincludePropertyNames
- if true, the method will also return property names at
additional call costs.IOException
InconsistentRecordsException
PIDInformation queryByTypeWithConformance(String pid, String typeIdentifier, boolean includePropertyNames) throws IOException, InconsistentRecordsException
queryByType(java.lang.String, java.lang.String, boolean)
, but also performs a type conformance check.
The result of the check will be available from the PID information record
returned.pid
- typeIdentifier
- includePropertyNames
- IOException
InconsistentRecordsException
PIDInformation queryByTypeWithConformance(String pid, List<String> typeIdentifiers, boolean includePropertyNames) throws IOException, InconsistentRecordsException
EntityClass determineEntityClass(String identifier) throws IOException
identifier
- EntityClass
IOException
Copyright © 2014. All rights reserved.