com.ptc.core.meta.common.impl
Class LogicalIdentifierFactory

java.lang.Object
  com.ptc.core.meta.common.impl.LogicalIdentifierFactory

All Implemented Interfaces:

IdentifierFactory

public final class LogicalIdentifierFactory
extends Object
implements IdentifierFactory

Supported API: true

Extendable: false

Method Summary

Identifier	get(String identifier_external_form) From the identifier_external_form, we will construct an Identifier.
Identifier[]	get(String[] identifier_external_forms) Bulk mode of the get(String) method.
Identifier[]	get(String[] identifier_external_forms, Identifier identifier_context) Bulk mode of the get(String, TypeIdentifier) method.
Identifier[]	get(String[] identifier_external_forms, String identifier_context_external_form) Bulk mode of the get(String, String) method.
Identifier	get(String identifier_external_form, Identifier identifier_context) Construct a DefinitionIdentifier based on the external form and the context(TypeIdentifier).
Identifier	get(String identifier_external_form, String identifier_context_external_form) Construct an Identifier based on the combined string from the external form and the context external form.
InstanceIdentifier	newNamedInstanceIdentifier(String the_name, TypeInstanceIdentifier container) Supported API: true
InstanceIdentifier	newPathInstanceIdentifier(String the_path, TypeInstanceIdentifier container) Supported API: true
InstanceIdentifier	newUninitializedInstanceIdentifier(TypeInstanceIdentifier container) Supported API: true
TypeIdentifier	newWCTypeIdentifier(String type_name) Supported API: true
TypeInstanceIdentifier	newWCTypeInstanceIdentifier(String type_name, int update_count, long object_id) Supported API: true
TypeInstanceIdentifier	newWCTypeInstanceIdentifier(String type_name, int update_count, long object_id, long branch_id) Supported API: true

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

get

public Identifier get(String identifier_external_form)
               throws IllegalFormatException

From the identifier_external_form, we will construct an Identifier. If the external form represents a DefinitionIdentifier, a DefinitionIdentifier will be constructed. If the external form represents an ElementIdentifier, an ElementIdentifier will be constructed. If the external form only represents an InstanceIdentifier, an InstanceIdentifier will be constructed instead.

Supported API: true

Specified by:

get in interface IdentifierFactory

Parameters:

identifier_external_form -

Returns:

Identifier

Throws:

IllegalFormatException

get

public Identifier get(String identifier_external_form,
                      String identifier_context_external_form)
               throws IllegalFormatException

Construct an Identifier based on the combined string from the external form and the context external form. The only valid external form input are "DefinitionIdentifier, DefinitionIdentifier" or "ElementIdentifier, ElementIdentifier". Other inputs will cause IllegalFormatException.

Supported API: true

Specified by:

get in interface IdentifierFactory

Parameters:

identifier_external_form -

identifier_context_external_form -

Returns:

Identifier

Throws:

IllegalFormatException

get

public Identifier get(String identifier_external_form,
                      Identifier identifier_context)
               throws IllegalFormatException

Construct a DefinitionIdentifier based on the external form and the context(TypeIdentifier). If the external form is not representing a DefinitionIdentifier, IllegalFormatException will be thrown.

Supported API: true

Specified by:

get in interface IdentifierFactory

Parameters:

identifier_external_form -

identifier_context -

Returns:

Identifier

Throws:

IllegalFormatException

get

public Identifier[] get(String[] identifier_external_forms)
                 throws IllegalFormatException

Bulk mode of the get(String) method.

Supported API: true

Specified by:

get in interface IdentifierFactory

Parameters:

identifier_external_forms -

Returns:

Identifier[]

Throws:

IllegalFormatException

get

public Identifier[] get(String[] identifier_external_forms,
                        String identifier_context_external_form)
                 throws IllegalFormatException

Bulk mode of the get(String, String) method.

Supported API: true

Specified by:

get in interface IdentifierFactory

Parameters:

identifier_external_forms -

identifier_context_external_form -

Returns:

Identifier[]

Throws:

IllegalFormatException

get

public Identifier[] get(String[] identifier_external_forms,
                        Identifier identifier_context)
                 throws IllegalFormatException

Bulk mode of the get(String, TypeIdentifier) method.

Supported API: true

Specified by:

get in interface IdentifierFactory

Parameters:

identifier_external_forms -

identifier_context -

Returns:

Identifier[]

Throws:

IllegalFormatException

newWCTypeIdentifier

public TypeIdentifier newWCTypeIdentifier(String type_name)

Supported API: true

Specified by:

newWCTypeIdentifier in interface IdentifierFactory

Parameters:

type_name -

Returns:

TypeIdentifier

newWCTypeInstanceIdentifier

public TypeInstanceIdentifier newWCTypeInstanceIdentifier(String type_name,
                                                          int update_count,
                                                          long object_id)

Supported API: true

Specified by:

newWCTypeInstanceIdentifier in interface IdentifierFactory

Parameters:

type_name -

update_count -

object_id -

Returns:

TypeInstanceIdentifier

newWCTypeInstanceIdentifier

public TypeInstanceIdentifier newWCTypeInstanceIdentifier(String type_name,
                                                          int update_count,
                                                          long object_id,
                                                          long branch_id)

Supported API: true

Specified by:

newWCTypeInstanceIdentifier in interface IdentifierFactory

Parameters:

type_name -

update_count -

object_id -

branch_id -

Returns:

TypeInstanceIdentifier

newUninitializedInstanceIdentifier

public InstanceIdentifier newUninitializedInstanceIdentifier(TypeInstanceIdentifier container)

Supported API: true

Specified by:

newUninitializedInstanceIdentifier in interface IdentifierFactory

Parameters:

container -

Returns:

InstanceIdentifier

newNamedInstanceIdentifier

public InstanceIdentifier newNamedInstanceIdentifier(String the_name,
                                                     TypeInstanceIdentifier container)

Supported API: true

Specified by:

newNamedInstanceIdentifier in interface IdentifierFactory

Parameters:

the_name -

container -

Returns:

InstanceIdentifier

newPathInstanceIdentifier

public InstanceIdentifier newPathInstanceIdentifier(String the_path,
                                                    TypeInstanceIdentifier container)

Supported API: true

Specified by:

newPathInstanceIdentifier in interface IdentifierFactory

Parameters:

the_path -

container -

Returns:

InstanceIdentifier