org.openmdx.ui1.jdo2
Class Segment

java.lang.Object
  extended by org.oasisopen.jdo2.Identifiable
      extended by org.w3c.jdo2.AbstractObject
          extended by org.openmdx.base.jdo2.Segment
              extended by org.openmdx.ui1.jdo2.Segment
All Implemented Interfaces:
Serializable, javax.jdo.spi.Detachable, javax.jdo.spi.PersistenceCapable, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.Segment, org.openmdx.compatibility.view1.cci2.ViewCapable

public class Segment
extends org.openmdx.base.jdo2.Segment
implements Segment

Class Segment

See Also:
Serialized Form

Nested Class Summary
static class Segment.Slice
          Slice object hold the Segment's multivalued attributes
 
Nested classes/interfaces inherited from class org.openmdx.base.jdo2.Segment
org.openmdx.base.jdo2.Segment.Identity
 
Nested classes/interfaces inherited from class org.w3c.jdo2.AbstractObject
org.w3c.jdo2.AbstractObject.EmbeddedList<E>, org.w3c.jdo2.AbstractObject.EmbeddedSet<E>
 
Nested classes/interfaces inherited from interface org.openmdx.base.cci2.Segment
org.openmdx.base.cci2.Segment.Identity
 
Nested classes/interfaces inherited from interface javax.jdo.spi.PersistenceCapable
javax.jdo.spi.PersistenceCapable.ObjectIdFieldConsumer, javax.jdo.spi.PersistenceCapable.ObjectIdFieldManager, javax.jdo.spi.PersistenceCapable.ObjectIdFieldSupplier
 
Field Summary
static List<String> CLASS
          Define the model class org::openmdx::ui1::Segment
 
Fields inherited from class org.openmdx.base.jdo2.Segment
BASE_CLASS
 
Fields inherited from interface javax.jdo.spi.PersistenceCapable
CHECK_READ, CHECK_WRITE, LOAD_REQUIRED, MEDIATE_READ, MEDIATE_WRITE, READ_OK, READ_WRITE_OK, SERIALIZABLE
 
Constructor Summary
Segment()
           
 
Method Summary
 void addElement(boolean idIsPersistent, String id, Element element)
          Adds the specified element to the set of the values for the reference element.
 void addElementDefinition(boolean nameIsPersistent, String name, ElementDefinition elementDefinition)
          Adds the specified element to the set of the values for the reference elementDefinition.
 void addFeatureDefinition(boolean qualifiedNameIsPersistent, String qualifiedName, FeatureDefinition featureDefinition)
          Adds the specified element to the set of the values for the reference featureDefinition.
 org.openmdx.base.cci2.Void assertInspector(String forClass)
           
 SegmentExportElementsResult exportElements(boolean includeAutoGenerated)
           
<T extends AssertableInspector>
Collection<T>
getAssertableInspector()
          Retrieves a set containing all the elements for the reference assertableInspector.
 AssertableInspector getAssertableInspector(boolean nameIsPersistent, String name)
          Retrieves the value for the reference assertableInspector for the specified qualifier attribute value.
<T extends Element>
Collection<T>
getElement()
          Retrieves a set containing all the elements for the reference element.
 Element getElement(boolean idIsPersistent, String id)
          Retrieves the value for the reference element for the specified qualifier attribute value.
<T extends ElementDefinition>
Collection<T>
getElementDefinition()
          Retrieves a set containing all the elements for the reference elementDefinition.
 ElementDefinition getElementDefinition(boolean nameIsPersistent, String name)
          Retrieves the value for the reference elementDefinition for the specified qualifier attribute value.
<T extends FeatureDefinition>
Collection<T>
getFeatureDefinition()
          Retrieves a set containing all the elements for the reference featureDefinition.
 FeatureDefinition getFeatureDefinition(boolean qualifiedNameIsPersistent, String qualifiedName)
          Retrieves the value for the reference featureDefinition for the specified qualifier attribute value.
static org.openmdx.base.jdo2.Segment.Identity newIdentity(org.openmdx.base.cci2.Provider.Identity provider, boolean qualifiedNameIsPersistent, String qualifiedName)
           
protected  org.w3c.jdo2.AbstractObject.Slice newSlice(int index)
           
protected  List<String> openmdxjdoGetClass()
          Retrieve the model class
protected  int openmdxjdoGetSize(int field)
           
protected
<E extends org.w3c.jdo2.AbstractObject.Slice>
SortedMap<Integer,E>
openmdxjdoGetSlices()
           
protected  void openmdxjdoSetSize(int field, int size)
           
static org.openmdx.base.jdo2.Segment.Identity openmdxjdoToIdentity(org.oasisopen.spi2.ObjectId objectId)
           
 
Methods inherited from class org.openmdx.base.jdo2.Segment
addToProvider, addToProvider, getDescription, getProvider, getView, getView, jdoCopyFields, jdoCopyKeyFieldsFromObjectId, jdoCopyKeyFieldsFromObjectId, jdoCopyKeyFieldsToObjectId, jdoCopyKeyFieldsToObjectId, jdoGetObjectId, jdoGetPersistenceManager, jdoGetTransactionalObjectId, jdoGetVersion, jdoIsDeleted, jdoIsDetached, jdoIsDetachedInternal, jdoIsDirty, jdoIsNew, jdoIsPersistent, jdoIsTransactional, jdoMakeDirty, jdoNewInstance, jdoNewInstance, jdoNewObjectIdInstance, jdoNewObjectIdInstance, jdoPreSerialize, jdoProvideField, jdoProvideFields, jdoReplaceDetachedState, jdoReplaceField, jdoReplaceFields, jdoReplaceFlags, jdoReplaceStateManager, openmdxjdoGetObjectId, openmdxjdoGetObjectsByParent, setDescription
 
Methods inherited from class org.w3c.jdo2.AbstractObject
openmdxjdoClassName, openmdxjdoGetIdentityBuilder, openmdxjdoGetList, openmdxjdoGetObjectsByParent, openmdxjdoGetSet, openmdxjdoGetSparseArray, openmdxjdoNewSlice, openmdxjdoSetArray, openmdxjdoSetCollection, openmdxjdoToArray, openmdxjdoToArray, openmdxjdoValidateElement
 
Methods inherited from class org.oasisopen.jdo2.Identifiable
openmdxjdoGetObject, openmdxjdoGetObjectById, openmdxjdoGetObjectId, openmdxjdoGetObjectSet, openmdxjdoNewObjectId, openmdxjdoNewObjectId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.openmdx.base.cci2.Segment
getDescription, getProvider, setDescription
 
Methods inherited from interface org.openmdx.compatibility.view1.cci2.ViewCapable
getView, getView
 

Field Detail

CLASS

public static final List<String> CLASS
Define the model class org::openmdx::ui1::Segment

Constructor Detail

Segment

public Segment()
Method Detail

openmdxjdoGetSlices

protected final <E extends org.w3c.jdo2.AbstractObject.Slice> SortedMap<Integer,E> openmdxjdoGetSlices()
Overrides:
openmdxjdoGetSlices in class org.w3c.jdo2.AbstractObject

getFeatureDefinition

public <T extends FeatureDefinition> Collection<T> getFeatureDefinition()
Retrieves a set containing all the elements for the reference featureDefinition.

Returns:
A set containing all the elements for this reference.

getFeatureDefinition

public FeatureDefinition getFeatureDefinition(boolean qualifiedNameIsPersistent,
                                              String qualifiedName)
Retrieves the value for the reference featureDefinition for the specified qualifier attribute value.

Parameters:
qualifiedNameIsPersistent - Defines whether value for the qualifier is persistent or not
qualifiedName - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addFeatureDefinition

public void addFeatureDefinition(boolean qualifiedNameIsPersistent,
                                 String qualifiedName,
                                 FeatureDefinition featureDefinition)
Adds the specified element to the set of the values for the reference featureDefinition.

Note: This is an extension to the JMI 1 standard.

Parameters:
qualifiedNameIsPersistent - true if qualifiedName is persistent
qualifiedName - The qualifier attribute value that qualifies the reference to get the element to be appended.
featureDefinition - The element to be appended.

getElementDefinition

public <T extends ElementDefinition> Collection<T> getElementDefinition()
Retrieves a set containing all the elements for the reference elementDefinition.

Returns:
A set containing all the elements for this reference.

getElementDefinition

public ElementDefinition getElementDefinition(boolean nameIsPersistent,
                                              String name)
Retrieves the value for the reference elementDefinition for the specified qualifier attribute value.

Parameters:
nameIsPersistent - Defines whether value for the qualifier is persistent or not
name - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addElementDefinition

public void addElementDefinition(boolean nameIsPersistent,
                                 String name,
                                 ElementDefinition elementDefinition)
Adds the specified element to the set of the values for the reference elementDefinition.

Note: This is an extension to the JMI 1 standard.

Parameters:
nameIsPersistent - true if name is persistent
name - The qualifier attribute value that qualifies the reference to get the element to be appended.
elementDefinition - The element to be appended.

getElement

public <T extends Element> Collection<T> getElement()
Retrieves a set containing all the elements for the reference element.

Returns:
A set containing all the elements for this reference.

getElement

public Element getElement(boolean idIsPersistent,
                          String id)
Retrieves the value for the reference element for the specified qualifier attribute value.

Parameters:
idIsPersistent - Defines whether value for the qualifier is persistent or not
id - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

addElement

public void addElement(boolean idIsPersistent,
                       String id,
                       Element element)
Adds the specified element to the set of the values for the reference element.

Note: This is an extension to the JMI 1 standard.

Parameters:
idIsPersistent - true if id is persistent
id - The qualifier attribute value that qualifies the reference to get the element to be appended.
element - The element to be appended.

assertInspector

public org.openmdx.base.cci2.Void assertInspector(String forClass)

getAssertableInspector

public <T extends AssertableInspector> Collection<T> getAssertableInspector()
Retrieves a set containing all the elements for the reference assertableInspector.

Returns:
A set containing all the elements for this reference.

getAssertableInspector

public AssertableInspector getAssertableInspector(boolean nameIsPersistent,
                                                  String name)
Retrieves the value for the reference assertableInspector for the specified qualifier attribute value.

Parameters:
nameIsPersistent - Defines whether value for the qualifier is persistent or not
name - The value for the qualifier attribute that qualifies this reference.
Returns:
The possibly null value for this qualifier

exportElements

public SegmentExportElementsResult exportElements(boolean includeAutoGenerated)

openmdxjdoGetSize

protected int openmdxjdoGetSize(int field)
Overrides:
openmdxjdoGetSize in class org.w3c.jdo2.AbstractObject

openmdxjdoSetSize

protected void openmdxjdoSetSize(int field,
                                 int size)
Overrides:
openmdxjdoSetSize in class org.w3c.jdo2.AbstractObject

newSlice

protected org.w3c.jdo2.AbstractObject.Slice newSlice(int index)

openmdxjdoGetClass

protected List<String> openmdxjdoGetClass()
Retrieve the model class

Overrides:
openmdxjdoGetClass in class org.openmdx.base.jdo2.Segment
Returns:
the model class
See Also:
Segment.CLASS

newIdentity

public static org.openmdx.base.jdo2.Segment.Identity newIdentity(org.openmdx.base.cci2.Provider.Identity provider,
                                                                 boolean qualifiedNameIsPersistent,
                                                                 String qualifiedName)

openmdxjdoToIdentity

public static org.openmdx.base.jdo2.Segment.Identity openmdxjdoToIdentity(org.oasisopen.spi2.ObjectId objectId)


This software is published under the BSD license. Copyright © 2006-2008, OMEX AG, Switzerland, All rights reserved. Use is subject to license terms.