Module org.apache.sis.metadata

Package org.apache.sis.util.iso

Class DefaultMemberName

Object

AbstractName

DefaultLocalName

DefaultMemberName

All Implemented Interfaces:

Serializable, Comparable<Generic­Name>, Generic­Name, Local­Name, Member­Name

public class DefaultMemberName
extends DefaultLocalName
implements MemberName

The name to identify a member of a record. Default­Member­Name can be instantiated by any of the following methods:

• Default­Name­Factory.create­Member­Name(Name­Space, Char­Sequence, Type­Name)
• Similar static convenience method in Names.

Immutability and thread safety

This class is immutable and thus inherently thread-safe if the Name­Space, Char­Sequence and Type­Name arguments given to the constructor are also immutable. Subclasses shall make sure that any overridden methods remain safe to call from multiple threads and do not change any public Member­Name state.

Since:

0.3

See Also:

• Default­Type­Name
• Default­Name­Factory
• Default­Record­Type
• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Default­Member­Name(Name­Space scope, Char­Sequence name, Type­Name attribute­Type)	Constructs a member name from the given character sequence and attribute type.

Method Summary

Modifier and Type	Method	Description
static Default­Member­Name	cast­Or­Copy(Member­Name object)	Returns a SIS member name implementation with the values of the given arbitrary implementation.
boolean	equals(Object object)	Compares this member name with the specified object for equality.
Type­Name	get­Attribute­Type()	Returns the type of the data associated with the record member.

Methods inherited from class DefaultLocalName

cast­Or­Copy, compare­To, depth, get­Parsed­Names, head, scope, tip, to­International­String, to­String

Methods inherited from class AbstractName

cast­Or­Copy, hash­Code, push, to­Fully­Qualified­Name

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Methods inherited from interface Comparable

compare­To

Methods inherited from interface GenericName

push, scope, to­Fully­Qualified­Name, to­International­String

Methods inherited from interface LocalName

depth, get­Parsed­Names, head, tip, to­String

Constructor Details

DefaultMemberName

protected DefaultMemberName(NameSpace scope,
 CharSequence name,
 TypeName attributeType)

Constructs a member name from the given character sequence and attribute type.

Parameters:

scope - the scope of this name, or null for a global scope.

name - the local name (never null).

attribute­Type - the type of the data associated with the record member (cannot be null).

Method Details

castOrCopy

public static DefaultMemberName castOrCopy(MemberName object)

Returns a SIS member name implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:

• If the given object is null, then this method returns null.
• Otherwise if the given object is already an instance of Default­Member­Name, then it is returned unchanged.
• Otherwise a new Default­Member­Name instance is created with the same values than the given name.

Parameters:

object - the object to get as a SIS implementation, or null if none.

Returns:

a SIS implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

0.5

getAttributeType

public TypeName getAttributeType()

Returns the type of the data associated with the record member.

Specified by:

get­Attribute­Type in interface Member­Name

Returns:

the type of the data associated with the record member.

equals

public boolean equals(Object object)

Compares this member name with the specified object for equality.

Overrides:

equals in class Default­Local­Name

Parameters:

object - the object to compare with this name for equality.

Returns:

true if the given object is equal to this name.