VirtualBook

java.lang.Object
- org.barrelorgandiscovery.virtualbook.VirtualBook

All Implemented Interfaces:: java.io.Serializable, VirtualBookSectionManipulation

public class VirtualBook
extends java.lang.Object
implements java.io.Serializable, VirtualBookSectionManipulation

Virtual book

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description
`VirtualBook(Scale scale)` default constructor
`VirtualBook(Scale scale, java.util.ArrayList<Hole> holes)` Constructor
`VirtualBook(Scale scale, VirtualBook copy)` construct a new VirtualBook with holes and events

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAndMerge(Hole n)` Add and merge hole if some holes are overlapping
`void`	`addEvent(AbstractEvent event)` Add an Event
`void`	`addHole(java.util.Collection<Hole> holecollection)` Add a hole collection to the book
`void`	`addHole(Hole hole)` Add a hole in the book
`void`	`addHoles(java.util.Collection<Hole> holecollection)` add a list of holes
`void`	`clear()` This method clear all the holes on the book
`VirtualBook`	`clone()` Clone the content of the virtual book
`void`	`cutHoles(Hole n)` Cut book by the hole passed in parameter
`java.util.ArrayList<AbstractEvent>`	`findEvents(long start, long end, java.lang.Class<?> type)` find events of a given type from a start and end
`java.util.ArrayList<Hole>`	`findHoles(long start)` Find all the holes from the start position
`java.util.ArrayList<Hole>`	`findHoles(long start, long length)` Find all the holes in the window specified in parameters
`void`	`findHoles(long start, long length, java.util.Collection<Hole> result, HoleFilter f)` Find all the holes in the window specified in parameters, with an additionnal filter
`java.util.List<Hole>`	`findHoles(long start, long length, int firsttrack, int endtrack)` Recherche des notes dans la fenetre donnée
`void`	`findHoles(long start, long length, int firsttrack, int endtrack, java.util.List<Hole> resultList)` Recherche toutes les notes dans la fenetre donnée de temps donnée
`void`	`findHoles(long start, long length, int firsttrack, int endtrack, java.util.Set<Hole> result)` Recherche toutes les notes dans la fenetre donnée de temps donnée
`void`	`findHoles(long start, long length, java.util.Set<Hole> result)` Find all the holes in the window specified in parameters
`<T extends AbstractEvent> T`	`findNextEvent(T ae)` Find the next event of the same type
`<T extends AbstractEvent> T`	`findPreviousEvent(long timeStamp, java.lang.Class<T> type)` Find the previous event applicable from this timeStamp
`int`	`findSection(long timestamp)` Get the section from the timestamp
`VirtualBook`	`flattenVirtualBook()` Create a new Virtual Book where all overlapped holes are merged
`long`	`getFirstHoleStart()` get the first hole timestamp, if not found, Long.MAX_VALUE is returned
`java.util.ArrayList<Hole>`	`getHolesCopy()` Deprecated.
`long`	`getLength_fast()` Get the book length in microseconds
`long`	`getLength()` Get the book length in microseconds
`long`	`getMarkerLength(MarkerEvent marker)` Return the length of the marker (the length from the marker to the next one, or the end of the virtualbook)
`VirtualBookMetadata`	`getMetadata()` set virtual book metadata object
`java.lang.String`	`getName()` Get the name
`java.util.Set<AbstractEvent>`	`getOrderedEventsByRef()` get the events, ordered by timestamp [READ ONLY]
`java.util.ArrayList<Hole>`	`getOrderedHolesCopy()` Get a copy of all the holes, sorted by timestamp
`Scale`	`getScale()` Get the reference scale of the book
`int`	`getSectionCount()` get the section count
`java.lang.String[]`	`getSectionRegisters(int section)` get the activated registers in the section
`long`	`getSectionStart(int section)` get the section start of a section
`protected org.barrelorgandiscovery.virtualbook.VirtualBook.SelectionContent`	`getSelectionContent(Fragment sel)` Select the holes belonging to the selection, hole that start and the end of the selection are not taken into consideration
`int`	`hashCode()`
`void`	`insertAt(Fragment selection, long atPosition)` insert in the book the selection at the given atPosition, this will extend the virtualbook for inserting the region
`java.util.List<MarkerEvent>`	`listMarkers()` Return the list of markers
`void`	`removeEvent(AbstractEvent event)` remove an event
`void`	`removeFragment(Fragment selection)` Remove the selection from the book
`void`	`removeHole(Hole n)` Remove a hole :-)computer science priviledge :-)
`void`	`removeHoles(java.util.List<Hole> holes)` remove a list of hole
`Fragment`	`selectMarker(MarkerEvent marker)` Select the marker
`Fragment`	`selectMarkers(MarkerEvent from, MarkerEvent to)` Make a selection
`void`	`setMetadata(VirtualBookMetadata metadata)` get virtual book metadata object
`void`	`setName(java.lang.String name)` Set the name
`void`	`shift(long delta)`
`void`	`shiftAt(long start, long delta)` shift the holes, that begin at start and events of a delta (in micro seconds) from the start position
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VirtualBook
```
public VirtualBook(Scale scale)
```
    default constructor
    
    Parameters:
    
    scale - the scale of this book
  - VirtualBook
```
public VirtualBook(Scale scale,
                   java.util.ArrayList<Hole> holes)
```
    Constructor
    
    Parameters:
    
    scale - scale
    
    holes - the holes for the book
  - VirtualBook
```
public VirtualBook(Scale scale,
                   VirtualBook copy)
```
    construct a new VirtualBook with holes and events
- Method Detail
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - getScale
```
public Scale getScale()
```
    Get the reference scale of the book
    
    Returns:
    
    the book's scale
  - addHole
```
public void addHole(Hole hole)
```
    Add a hole in the book
    
    Parameters:
    
    hole - hole to add
  - addHole
```
public void addHole(java.util.Collection<Hole> holecollection)
```
    Add a hole collection to the book
    
    Parameters:
    
    holecollection -
  - addHoles
```
public void addHoles(java.util.Collection<Hole> holecollection)
```
    add a list of holes
    
    Parameters:
    
    holecollection -
  - addAndMerge
```
public void addAndMerge(Hole n)
```
    Add and merge hole if some holes are overlapping
    
    Parameters:
    
    n -
  - cutHoles
```
public void cutHoles(Hole n)
```
    Cut book by the hole passed in parameter
    
    Parameters:
    
    n - la note de decoupe
  - removeHole
```
public void removeHole(Hole n)
```
    Remove a hole :-)computer science priviledge :-)
    
    Parameters:
    
    n -
  - removeHoles
```
public void removeHoles(java.util.List<Hole> holes)
```
    remove a list of hole
    
    Parameters:
    
    holes -
  - clear
```
public void clear()
```
    This method clear all the holes on the book
    
    Since:
    
    2011.6
  - findHoles
```
public java.util.ArrayList<Hole> findHoles(long start,
                                           long length)
```
    Find all the holes in the window specified in parameters
    
    Parameters:
    
    start -
    
    length -
    
    Returns:
    
    the holes arraylist in the range
  - findHoles
```
public java.util.ArrayList<Hole> findHoles(long start)
```
    Find all the holes from the start position
    
    Parameters:
    
    start -
    
    Returns:
    
    the holes arraylist in the range
  - findHoles
```
public void findHoles(long start,
                      long length,
                      java.util.Set<Hole> result)
```
    Find all the holes in the window specified in parameters
    
    Parameters:
    
    result - the list to be filled
    
    start -
    
    length -
  - findHoles
```
public void findHoles(long start,
                      long length,
                      java.util.Collection<Hole> result,
                      HoleFilter f)
```
    Find all the holes in the window specified in parameters, with an additionnal filter
    
    Parameters:
    
    result - the list to be filled
    
    start -
    
    length -
    
    f - the additional filter
  - findHoles
```
public void findHoles(long start,
                      long length,
                      int firsttrack,
                      int endtrack,
                      java.util.Set<Hole> result)
```
    Recherche toutes les notes dans la fenetre donnée de temps donnée
    
    Parameters:
    
    start -
    
    length -
  - findHoles
```
public void findHoles(long start,
                      long length,
                      int firsttrack,
                      int endtrack,
                      java.util.List<Hole> resultList)
```
    Recherche toutes les notes dans la fenetre donnée de temps donnée
    
    Parameters:
    
    start -
    
    length -
  - findHoles
```
public java.util.List<Hole> findHoles(long start,
                                      long length,
                                      int firsttrack,
                                      int endtrack)
```
    Recherche des notes dans la fenetre donnée
    
    Parameters:
    
    start - the start timestamp
    
    length - the length of the search
    
    firsttrack - the first track
    
    endtrack -
    
    Returns:
    
    the array of holes found
  - getLength
```
public long getLength()
```
    Get the book length in microseconds
    
    Returns:
    
    the book length in microseconds
  - getLength_fast
```
public long getLength_fast()
```
    Get the book length in microseconds
    
    Returns:
    
    the book length in microseconds
  - getFirstHoleStart
```
public long getFirstHoleStart()
```
    get the first hole timestamp, if not found, Long.MAX_VALUE is returned
    
    Returns:
    
    get the first hole timestamp
  - shift
```
public void shift(long delta)
```
  - shiftAt
```
public void shiftAt(long start,
                    long delta)
```
    shift the holes, that begin at start and events of a delta (in micro seconds) from the start position
    
    Parameters:
    
    delta -
  - getOrderedHolesCopy
```
public java.util.ArrayList<Hole> getOrderedHolesCopy()
```
    Get a copy of all the holes, sorted by timestamp
    
    Returns:
    
    get a copy array of the contained holes in the book
  - getHolesCopy
```
@Deprecated
public java.util.ArrayList<Hole> getHolesCopy()
```
    Deprecated.
    
    Get a copy of the holes
    
    Returns:
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getName
```
public java.lang.String getName()
```
    Get the name
    
    Returns:
    
    the name of the book
  - setName
```
public void setName(java.lang.String name)
```
    Set the name
    
    Parameters:
    
    name -
  - addEvent
```
public void addEvent(AbstractEvent event)
```
    Add an Event
    
    Parameters:
    
    event -
  - findEvents
```
public java.util.ArrayList<AbstractEvent> findEvents(long start,
                                                     long end,
                                                     java.lang.Class<?> type)
```
    find events of a given type from a start and end
    
    Parameters:
    
    start - start
    
    end - end
    
    type - event type, or null if all events are wished
    
    Returns:
    
    the events in the specified range
  - findPreviousEvent
```
public <T extends AbstractEvent> T findPreviousEvent(long timeStamp,
                                                     java.lang.Class<T> type)
```
    Find the previous event applicable from this timeStamp
    
    Type Parameters:
    
    T - the event Type
    
    Parameters:
    
    timeStamp - the timeStamp
    
    type - the type of the event
    
    Returns:
  - findNextEvent
```
public <T extends AbstractEvent> T findNextEvent(T ae)
```
    Find the next event of the same type
    
    Type Parameters:
    
    T - the event Type
    
    Parameters:
    
    ae - the abstract event
    
    Returns:
  - getOrderedEventsByRef
```
public java.util.Set<AbstractEvent> getOrderedEventsByRef()
```
    get the events, ordered by timestamp [READ ONLY]
  - removeEvent
```
public void removeEvent(AbstractEvent event)
```
    remove an event
    
    Parameters:
    
    event -
  - getSectionCount
```
public int getSectionCount()
```
    get the section count
    
    Returns:
    
    the number of registers section computed in the book
  - getSectionStart
```
public long getSectionStart(int section)
```
    get the section start of a section
    
    Parameters:
    
    section -
    
    Returns:
  - getSectionRegisters
```
public java.lang.String[] getSectionRegisters(int section)
```
    get the activated registers in the section
    
    Parameters:
    
    section - the section index
    
    Returns:
    
    the activated registers in the section
  - findSection
```
public int findSection(long timestamp)
```
    Get the section from the timestamp
    
    Parameters:
    
    timestamp -
    
    Returns:
  - flattenVirtualBook
```
public VirtualBook flattenVirtualBook()
```
    Create a new Virtual Book where all overlapped holes are merged
    
    Returns:
  - setMetadata
```
public void setMetadata(VirtualBookMetadata metadata)
```
    get virtual book metadata object
    
    Parameters:
    
    metadata -
  - getMetadata
```
public VirtualBookMetadata getMetadata()
```
    set virtual book metadata object
    
    Returns:
  - listMarkers
```
public java.util.List<MarkerEvent> listMarkers()
```
    Description copied from interface: VirtualBookSectionManipulation
    
    Return the list of markers
    
    Specified by:
    
    listMarkers in interface VirtualBookSectionManipulation
    
    Returns:
  - getMarkerLength
```
public long getMarkerLength(MarkerEvent marker)
```
    Description copied from interface: VirtualBookSectionManipulation
    
    Return the length of the marker (the length from the marker to the next one, or the end of the virtualbook)
    
    Specified by:
    
    getMarkerLength in interface VirtualBookSectionManipulation
    
    Returns:
  - selectMarker
```
public Fragment selectMarker(MarkerEvent marker)
```
    Description copied from interface: VirtualBookSectionManipulation
    
    Select the marker
    
    Specified by:
    
    selectMarker in interface VirtualBookSectionManipulation
    
    Returns:
  - selectMarkers
```
public Fragment selectMarkers(MarkerEvent from,
                              MarkerEvent to)
```
    Description copied from interface: VirtualBookSectionManipulation
    
    Make a selection
    
    Specified by:
    
    selectMarkers in interface VirtualBookSectionManipulation
    
    Returns:
  - getSelectionContent
```
protected org.barrelorgandiscovery.virtualbook.VirtualBook.SelectionContent getSelectionContent(Fragment sel)
```
    Select the holes belonging to the selection, hole that start and the end of the selection are not taken into consideration
    
    Parameters:
    
    sel -
    
    Returns:
  - insertAt
```
public void insertAt(Fragment selection,
                     long atPosition)
```
    Description copied from interface: VirtualBookSectionManipulation
    
    insert in the book the selection at the given atPosition, this will extend the virtualbook for inserting the region
    
    Specified by:
    
    insertAt in interface VirtualBookSectionManipulation
    
    Parameters:
    
    selection - the selection
    
    atPosition - the position
  - removeFragment
```
public void removeFragment(Fragment selection)
```
    Description copied from interface: VirtualBookSectionManipulation
    
    Remove the selection from the book
    
    Specified by:
    
    removeFragment in interface VirtualBookSectionManipulation
  - clone
```
public VirtualBook clone()
```
    Clone the content of the virtual book
    
    Overrides:
    
    clone in class java.lang.Object

Class VirtualBook

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VirtualBook

VirtualBook

VirtualBook

Method Detail

hashCode

getScale

addHole

addHole

addHoles

addAndMerge

cutHoles

removeHole

removeHoles

clear

findHoles

findHoles

findHoles

findHoles

findHoles

findHoles

findHoles

getLength

getLength_fast

getFirstHoleStart

shift

shiftAt

getOrderedHolesCopy

getHolesCopy

toString

getName

setName

addEvent

findEvents

findPreviousEvent

findNextEvent

getOrderedEventsByRef

removeEvent

getSectionCount

getSectionStart

getSectionRegisters

findSection

flattenVirtualBook

setMetadata

getMetadata

listMarkers

getMarkerLength

selectMarker

selectMarkers

getSelectionContent

insertAt

removeFragment

clone