com.evolveum.midpoint.schema.processor
Class Definition

java.lang.Object
  extended by com.evolveum.midpoint.schema.processor.Definition
Direct Known Subclasses:
PropertyContainerDefinition, PropertyDefinition

public abstract class Definition
extends java.lang.Object

Abstract definition in the schema. This is supposed to be a superclass for all definitions. It defines common properties for all definitions. The definitions represent data structures of the schema. Therefore instances of Java objects from this class represent specific definitions from the schema, not specific properties or objects. E.g the definitions does not have any value. To transform definition to a real property or object use the explicit instantiate() methods provided in the definition classes. E.g. the instantiate() method will create instance of Property using appropriate PropertyDefinition. The convenience methods in Schema are using this abstract class to find appropriate definitions easily.

Author:
Radovan Semancik

Method Summary
 java.lang.String debugDump(int indent)
           
 javax.xml.namespace.QName getDefaultName()
          Returns default name for the defined entity.
 java.lang.String getDisplayName()
          Returns display name.
 java.lang.String getHelp()
          Returns help string.
 javax.xml.namespace.QName getName()
          Returns name of the defined entity.
 javax.xml.namespace.QName getNameOrDefaultName()
          Returns either name (if specified) or default name.
 javax.xml.namespace.QName getTypeName()
          Returns the name of the definition type.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getName

public javax.xml.namespace.QName getName()
Returns name of the defined entity. The name is a name of the entity instance if it is fixed by the schema. E.g. it may be a name of the property in the container that cannot be changed. The name corresponds to the XML element name in the XML representation of the schema. It does NOT correspond to a XSD type name. If name is not set the null value is returned.

Returns:
the name name of the entity or null.

getDefaultName

public javax.xml.namespace.QName getDefaultName()
Returns default name for the defined entity. The default name is the name that the entity usually takes, but a name that is not fixed by the schema. The name corresponds to the XML element name in the XML representation of the schema. It does NOT correspond to a XSD type name. For example the default name may be the element name that is usually used for a specific object (e.g. "user"), while the same object may be represented using other names that resolve to the same type. In XML representation it corresponds to "defaultElement" XSD annotation.

Returns:
the defaultName

getTypeName

public javax.xml.namespace.QName getTypeName()
Returns the name of the definition type. Returns a name of the type for this definition. In XML representation that corresponds to the name of the XSD type.

Returns:
the typeName

getNameOrDefaultName

public javax.xml.namespace.QName getNameOrDefaultName()
Returns either name (if specified) or default name. Convenience method.

Returns:
name or default name

getDisplayName

public java.lang.String getDisplayName()
Returns display name. Specifies the printable name of the object class or attribute. It must contain a printable string. It may also contain a key to catalog file. Returns null if no display name is set. Corresponds to "displayName" XSD annotation.

Returns:
display name string or catalog key

getHelp

public java.lang.String getHelp()
Returns help string. Specifies the help text or a key to catalog file for a help text. The help text may be displayed in any suitable way by the GUI. It should explain the meaning of an attribute or object class. Returns null if no help string is set. Corresponds to "help" XSD annotation.

Returns:
help string or catalog key

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

debugDump

public java.lang.String debugDump(int indent)


Copyright © 2011 evolveum. All Rights Reserved.